Class KeyTransformDatastore

constructor

• new KeyTransformDatastore(
      child: Datastore,
      transform: KeyTransform,
  ): KeyTransformDatastore

  Parameters

  • child: Datastore
  • transform: KeyTransform

  Returns KeyTransformDatastore

transform

batch

• batch(): Batch

  This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

  Returns Batch

  Example

  const b = store.batch()
  
  for (let i = 0; i < 100; i++) {
    b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
  }
  
  await b.commit()
  console.log('put 100 values')
  Copy

delete

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

  Remove the record for the passed key

  Parameters

  • key: Key
  • Optionaloptions: AbortOptions

  Returns Promise<void>

  Example

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

deleteMany

• deleteMany(
      source: AwaitIterable<Key>,
      options?: AbortOptions,
  ): AsyncIterable<Key>

  Remove values for the passed keys

  Parameters

  • source: AwaitIterable<Key>
  • options: AbortOptions = {}

  Returns AsyncIterable<Key>

  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: Key, options?: AbortOptions): Promise<Uint8Array<ArrayBufferLike>>

  Retrieve the value stored under the given key

  Parameters

  • key: Key
  • Optionaloptions: AbortOptions

  Returns Promise<Uint8Array<ArrayBufferLike>>

  Example

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

getMany

• getMany(source: AwaitIterable<Key>, options?: AbortOptions): AsyncIterable<Pair>

  Retrieve values for the passed keys

  Parameters

  • source: AwaitIterable<Key>
  • options: AbortOptions = {}

  Returns AsyncIterable<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: Key, options?: AbortOptions): Promise<boolean>

  Check for the existence of a value for the passed key

  Parameters

  • key: Key
  • 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

put

• put(key: Key, val: Uint8Array, options?: AbortOptions): Promise<Key>

  Store the passed value under the passed key

  Parameters

  • key: Key
  • val: Uint8Array
  • Optionaloptions: AbortOptions

  Returns Promise<Key>

  Example

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

putMany

• putMany(source: AwaitIterable<Pair>, options?: AbortOptions): AsyncIterable<Key>

  Store the given key/value pairs

  Parameters

  • source: AwaitIterable<Pair>
  • options: AbortOptions = {}

  Returns AsyncIterable<Key>

  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

query

• query(q: Query, options?: AbortOptions): AsyncIterable<Pair>

  Query the datastore.

  Parameters

  • q: Query
  • Optionaloptions: AbortOptions

  Returns AsyncIterable<Pair>

  Example

  // retrieve __all__ key/value pairs from the store
  let list = []
  for await (const { key, value } of store.query({})) {
    list.push(value)
  }
  console.log('ALL THE VALUES', list)
  Copy

queryKeys

• queryKeys(q: KeyQuery, options?: AbortOptions): AsyncIterable<Key>

  Query the datastore.

  Parameters

  • q: KeyQuery
  • Optionaloptions: AbortOptions

  Returns AsyncIterable<Key>

  Example

  // retrieve __all__ keys from the store
  let list = []
  for await (const key of store.queryKeys({})) {
    list.push(key)
  }
  console.log('ALL THE KEYS', key)
  Copy