Interface BlockStorage

lock

createSession

• createSession(root: CID, options?: AbortOptions): SessionBlockstore

  A blockstore session only fetches blocks from a subset of network peers to reduce network traffic and improve performance.

  The initial set of peers can be specified, alternatively a findProviders routing query will occur to populate the set instead.

  Parameters

  • root: CID
  • Optionaloptions: AbortOptions

  Returns SessionBlockstore

delete

• delete(
      cid: CID,
      options?: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>,
  ): Promise<void>

  Delete a block from the blockstore

  Parameters

  • cid: CID
  • options: AbortOptions & ProgressOptions<DeleteBlockProgressEvents> = {}

  Returns Promise<void>

deleteMany

• deleteMany(
      cids: AwaitIterable<CID<unknown, number, number, Version>>,
      options?: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>,
  ): AsyncIterable<CID<unknown, number, number, Version>>

  Delete multiple blocks from the blockstore

  Parameters

  • cids: AwaitIterable<CID<unknown, number, number, Version>>
  • options: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents> = {}

  Returns AsyncIterable<CID<unknown, number, number, Version>>

get

• get(
      cid: CID,
      options?: GetOfflineOptions & AbortOptions & ProgressOptions<
          GetBlockProgressEvents,
      >,
  ): Promise<Uint8Array<ArrayBufferLike>>

  Get a block by cid

  Parameters

  • cid: CID
  • options: GetOfflineOptions & AbortOptions & ProgressOptions<GetBlockProgressEvents> = {}

  Returns Promise<Uint8Array<ArrayBufferLike>>

getAll

• getAll(
      options?: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>,
  ): AsyncIterable<Pair>

  Retrieve all cid/block pairs from the blockstore as an unordered iterable

  Parameters

  • options: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents> = {}

  Returns AsyncIterable<Pair>

  Example

  for await (const { multihash, block } of store.getAll()) {
    console.log('got:', multihash, block)
    // => got MultihashDigest('Qmfoo') Uint8Array[...]
  }
  Copy

getMany

• getMany(
      cids: AwaitIterable<CID<unknown, number, number, Version>>,
      options?: GetOfflineOptions & AbortOptions & ProgressOptions<
          GetManyBlocksProgressEvents,
      >,
  ): AsyncIterable<Pair>

  Get multiple blocks back from an (async) iterable of cids

  Parameters

  • cids: AwaitIterable<CID<unknown, number, number, Version>>
  • options: GetOfflineOptions & AbortOptions & ProgressOptions<GetManyBlocksProgressEvents> = {}

  Returns AsyncIterable<Pair>

has

• has(cid: CID, options?: AbortOptions): Promise<boolean>

  Check for the existence of a value for the passed key

  Parameters

  • cid: CID
  • options: AbortOptions = {}

  Returns Promise<boolean>

  Example

  const exists = await store.has(new Key('awesome'))
  
  if (exists) {
   console.log('it is there')
  } else {
   console.log('it is not there')
  }
  Copy

isStarted

• isStarted(): boolean

  Returns boolean

put

• put(
      cid: CID,
      block: Uint8Array,
      options?: AbortOptions & ProgressOptions<PutBlockProgressEvents>,
  ): Promise<CID<unknown, number, number, Version>>

  Put a block to the underlying datastore

  Parameters

  • cid: CID
  • block: Uint8Array
  • options: AbortOptions & ProgressOptions<PutBlockProgressEvents> = {}

  Returns Promise<CID<unknown, number, number, Version>>

putMany

• putMany(
      blocks: AwaitIterable<{ block: Uint8Array; cid: CID }>,
      options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
  ): AsyncIterable<CID<unknown, number, number, Version>>

  Put a multiple blocks to the underlying datastore

  Parameters

  • blocks: AwaitIterable<{ block: Uint8Array; cid: CID }>
  • options: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents> = {}

  Returns AsyncIterable<CID<unknown, number, number, Version>>

start

• start(): Promise<void>

  This method will be invoked to start the component.

  It should not assume that any other components have been started.

  Returns Promise<void>

stop

• stop(): Promise<void>

  This method will be invoked to stop the component.

  It should not assume any other components are running when it is called.

  Returns Promise<void>

unwrap

• unwrap(): Blockstore

  Returns Blockstore