Interface IStore

interface IStore {
    addLibp2pEventListener: (<K>(type, listener, options?) => void);
    allPeers: (() => Promise<Peer[]>);
    connectedPeers: (() => Promise<Peer[]>);
    multicodec: string;
    peerStore: PeerStore;
    queryGenerator: (<T>(decoders, options?) => AsyncGenerator<Promise<undefined | T>[], any, unknown>);
    queryWithOrderedCallback: (<T>(decoders, callback, options?) => Promise<void>);
    queryWithPromiseCallback: (<T>(decoders, callback, options?) => Promise<void>);
    removeLibp2pEventListener: {
        <K>(type, listener?, options?): void;
        (type, listener?, options?): void;
    };
    shardInfo?: ShardInfo;
}

Hierarchy (view full)

Properties

addLibp2pEventListener allPeers connectedPeers multicodec peerStore queryGenerator queryWithOrderedCallback queryWithPromiseCallback removeLibp2pEventListener shardInfo?

Properties

addLibp2pEventListener

addLibp2pEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void

    • Type Parameters

      • K extends keyof Libp2pEvents<ServiceMap>

      Parameters

      • type: K
      • listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
      • Optional options: boolean | AddEventListenerOptions

      Returns void

allPeers

allPeers: (() => Promise<Peer[]>)

Type declaration

    • (): Promise<Peer[]>

    • Returns Promise<Peer[]>

connectedPeers

connectedPeers: (() => Promise<Peer[]>)

Type declaration

    • (): Promise<Peer[]>

    • Returns Promise<Peer[]>

multicodec

multicodec: string

peerStore

peerStore: PeerStore

queryGenerator

queryGenerator: (<T>(decoders, options?) => AsyncGenerator<Promise<undefined | T>[], any, unknown>)

Type declaration

    • <T>(decoders, options?): AsyncGenerator<Promise<undefined | T>[], any, unknown>

    • Type Parameters

      Parameters

      Returns AsyncGenerator<Promise<undefined | T>[], any, unknown>

queryWithOrderedCallback

queryWithOrderedCallback: (<T>(decoders, callback, options?) => Promise<void>)

Type declaration

    • <T>(decoders, callback, options?): Promise<void>

    • Type Parameters

      Parameters

      • decoders: IDecoder<T>[]
      • callback: ((message) => boolean | void | Promise<boolean | void>)
          • (message): boolean | void | Promise<boolean | void>

          • Parameters

            • message: T

            Returns boolean | void | Promise<boolean | void>

      • Optional options: StoreQueryOptions

      Returns Promise<void>

queryWithPromiseCallback

queryWithPromiseCallback: (<T>(decoders, callback, options?) => Promise<void>)

Type declaration

    • <T>(decoders, callback, options?): Promise<void>

    • Type Parameters

      Parameters

      • decoders: IDecoder<T>[]
      • callback: ((message) => boolean | void | Promise<boolean | void>)
          • (message): boolean | void | Promise<boolean | void>

          • Parameters

            • message: Promise<undefined | T>

            Returns boolean | void | Promise<boolean | void>

      • Optional options: StoreQueryOptions

      Returns Promise<void>

removeLibp2pEventListener

removeLibp2pEventListener: {
    <K>(type, listener?, options?): void;
    (type, listener?, options?): void;
}

Type declaration

    • <K>(type, listener?, options?): void

    • Type Parameters

      • K extends keyof Libp2pEvents<ServiceMap>

      Parameters

      • type: K
      • Optional listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
      • Optional options: boolean | EventListenerOptions

      Returns void

    • (type, listener?, options?): void

    • Parameters

      • type: string
      • Optional listener: EventHandler<Event>
      • Optional options: boolean | EventListenerOptions

      Returns void

Optional shardInfo

shardInfo?: ShardInfo

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc