Class FsBlockstore

constructor

• new FsBlockstore(location: string, init?: FsBlockstoreInit): FsBlockstore

  Parameters

  • location: string
  • init: FsBlockstoreInit = {}

  Returns FsBlockstore

path

close

• close(): Promise<void>

  Returns Promise<void>

delete

• delete(key: CID, options?: AbortOptions): Promise<void>

  Remove the record for the passed key

  Parameters

  • key: CID
  • Optionaloptions: AbortOptions

  Returns Promise<void>

  Example

  await store.delete(new Key('awesome'))
  console.log('deleted awesome content :(')
  Copy

deleteMany

• deleteMany(
      source:
          | Iterable<CID<unknown, number, number, Version>, any, any>
          | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
      options?: AbortOptions,
  ): AsyncGenerator<CID<unknown, number, number, Version>>

  Remove values for the passed keys

  Parameters

  • source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>
  • Optionaloptions: AbortOptions

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

  Example

  const source = [new Key('awesome')]
  
  for await (const key of store.deleteMany(source)) {
    console.log(`deleted content with key ${key}`)
  }
  Copy

get

• get(
      key: CID,
      options?: AbortOptions,
  ): AsyncGenerator<Uint8Array<ArrayBufferLike>>

  Retrieve the value stored under the given key

  Parameters

  • key: CID
  • Optionaloptions: AbortOptions

  Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>

  Example

  const value = await store.get(new Key('awesome'))
  console.log('got content: %s', value.toString('utf8'))
  // => got content: datastore
  Copy

getAll

• getAll(
      options?: AbortOptions,
  ): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

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

  Parameters

  • Optionaloptions: AbortOptions

  Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

  Example

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

getMany

• getMany(
      source:
          | Iterable<CID<unknown, number, number, Version>, any, any>
          | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
      options?: AbortOptions,
  ): AsyncGenerator<Pair>

  Retrieve values for the passed keys

  Parameters

  • source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>
  • Optionaloptions: AbortOptions

  Returns AsyncGenerator<Pair>

  Example

  for await (const { key, value } of store.getMany([new Key('awesome')])) {
    console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
    // => got "/awesome" = "datastore"
  }
  Copy

has

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

  Check for the existence of a value for the passed key

  Parameters

  • key: CID
  • Optionaloptions: 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

open

• open(): Promise<void>

  Returns Promise<void>

put

• put(
      key: CID,
      val:
          | Uint8Array<ArrayBufferLike>
          | Iterable<Uint8Array<ArrayBufferLike>, any, any>
          | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>,
      options?: AbortOptions,
  ): Promise<CID<unknown, number, number, Version>>

  Store the passed value under the passed key

  Parameters

  • key: CID
  • val:
        | Uint8Array<ArrayBufferLike>
        | Iterable<Uint8Array<ArrayBufferLike>, any, any>
        | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>
  • Optionaloptions: AbortOptions

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

  Example

  await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
  Copy

putMany

• putMany(
      source: Iterable<Pair, any, any> | AsyncIterable<Pair, any, any>,
      options?: AbortOptions,
  ): AsyncGenerator<CID<unknown, number, number, Version>>

  Store the given key/value pairs

  Parameters

  • source: Iterable<Pair, any, any> | AsyncIterable<Pair, any, any>
  • Optionaloptions: AbortOptions

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

  Example

  const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]
  
  for await (const { key, value } of store.putMany(source)) {
    console.info(`put content for key ${key}`)
  }
  Copy