Interface IPeersRepository

interface IPeersRepository {
    deleteAll: () => MaybePromise<void>;
    getById: (
        id: number,
        allowMin: boolean,
    ) => MaybePromise<null | IPeersRepository.PeerInfo>;
    getByPhone: (
        phone: string,
    ) => MaybePromise<null | IPeersRepository.PeerInfo>;
    getByUsername: (
        username: string,
    ) => MaybePromise<null | IPeersRepository.PeerInfo>;
    store: (peer: IPeersRepository.PeerInfo) => MaybePromise<void>;
}

Index

Properties

deleteAll getById getByPhone getByUsername store

Properties

deleteAll

deleteAll: () => MaybePromise<void>

getById

getById: (
id: number,
allowMin: boolean,
) => MaybePromise<null | IPeersRepository.PeerInfo>

Find a peer by their id.

Type declaration

- (id: number, allowMin: boolean): MaybePromise<null | IPeersRepository.PeerInfo>
- Parameters
  - id: number
  - allowMin: boolean
    Whether to allow "min" peers to be returned
  Returns MaybePromise<null | IPeersRepository.PeerInfo>

getByPhone

getByPhone: (phone: string) => MaybePromise<null | IPeersRepository.PeerInfo>

Find a peer by their phone. Should never return "min" peers

getByUsername

getByUsername: (
username: string,
) => MaybePromise<null | IPeersRepository.PeerInfo>

Find a peer by their username (where usernames includes username). Should never return "min" peers

store

store: (peer: IPeersRepository.PeerInfo) => MaybePromise<void>

Store the given peer