Interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>

interface BlockBroker<
    RetrieveProgressEvents extends
        ProgressEvent<any, any> = ProgressEvent<any, any>,
    AnnounceProgressEvents extends
        ProgressEvent<any, any> = ProgressEvent<any, any>,
> {
    name: string;
    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

RetrieveProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>
AnnounceProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>

Hierarchy (View Summary)

BlockBroker
- SessionBlockBroker

Index

Properties

Methods

announce? createSession? retrieve?

Properties

name

name: string

The name of the block broker, used for logging purposes

Methods

`Optional`announce

announce?(
cid: CID,
options?: BlockAnnounceOptions<AnnounceProgressEvents>,
): Promise<void>
Make a new block available to peers
Parameters
- cid: CID
- Optionaloptions: BlockAnnounceOptions<AnnounceProgressEvents>
Returns Promise<void>
- Defined in packages/interface/src/blocks.ts:165

`Optional`createSession

createSession?(
options?: CreateSessionOptions<RetrieveProgressEvents>,
): SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>
Create a new session
Parameters
- Optionaloptions: CreateSessionOptions<RetrieveProgressEvents>
Returns SessionBlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>
- Defined in packages/interface/src/blocks.ts:170

`Optional`retrieve

retrieve?(
cid: CID,
options?: BlockRetrievalOptions<RetrieveProgressEvents>,
): Promise<Uint8Array<ArrayBufferLike>>
Retrieve a block from a source
Parameters
- cid: CID
- Optionaloptions: BlockRetrievalOptions<RetrieveProgressEvents>
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/interface/src/blocks.ts:160