helia
    Preparing search index...

    Interface SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>

    interface SessionBlockBroker<
        RetrieveProgressEvents extends
            ProgressEvent<any, any> = ProgressEvent<any, any>,
        AnnounceProgressEvents extends
            ProgressEvent<any, any> = ProgressEvent<any, any>,
    > {
        name: string;
        addPeer(
            peer: PeerId | Multiaddr | Multiaddr[],
            options?: AbortOptions,
        ): Promise<void>;
        announce?(
            cid: CID,
            options?: BlockAnnounceOptions<AnnounceProgressEvents>,
        ): Promise<void>;
        createSession?(
            options?: CreateSessionOptions<RetrieveProgressEvents>,
        ): SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>;
        retrieve?(
            cid: CID,
            options?: BlockRetrievalOptions<RetrieveProgressEvents>,
        ): Promise<Uint8Array<ArrayBufferLike>>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    name

    Methods

    addPeer announce? createSession? retrieve?

    Properties

    name: string

    The name of the block broker, used for logging purposes

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods