Interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>

interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents> {
    announce?(cid, block, options?): Promise<void>;
    createSession?(options?): BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>;
    retrieve?(cid, options?): Promise<Uint8Array>;
}

Type Parameters

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

Index

Methods

announce? createSession? retrieve?

Methods

`Optional` announce

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

`Optional` createSession

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

`Optional` retrieve

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