Class DataStore

Readonly[kMaybeHaveEventListener]

Readonlymutex

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Close the store.

  Returns Promise<void>

clearExpired

• clearExpired(): Promise<void>

  Delete all expired records.

  Returns Promise<void>

delete

• delete(...names: readonly Name[]): Promise<void>

  Delete Data packets with given names.

  Parameters

  • ...names: readonly Name[]

  Returns Promise<void>

  See

  Transaction.delete

find

• find(interest: Interest): Promise<undefined | Data>

  Find Data that satisfies Interest.

  Parameters

  • interest: Interest

  Returns Promise<undefined | Data>

get

• get(name: Name): Promise<undefined | Data>

  Retrieve Data by exact name.

  Parameters

  • name: Name

  Returns Promise<undefined | Data>

insert

• insert(
      ...args:
          | (Data | AnyIterable<Data>)[]
          | [InsertOptions, ...(Data | AnyIterable<Data>)[]],
  ): Promise<void>

  Insert one or more Data packets.

  Parameters

  • ...args: (Data | AnyIterable<Data>)[] | [InsertOptions, ...(Data | AnyIterable<Data>)[]]

  Returns Promise<void>

  See

  Transaction.insert

listData

• listData(prefix?: Name): AsyncIterable<Data>

  List Data packets, optionally filtered by name prefix.

  Parameters

  • Optionalprefix: Name

  Returns AsyncIterable<Data>

listNames

• listNames(prefix?: Name): AsyncIterable<Name>

  List Data names, optionally filtered by name prefix.

  Parameters

  • Optionalprefix: Name

  Returns AsyncIterable<Name>

tx

• tx(): Transaction

  Start an update transaction.

  Returns Transaction

Staticcreate

• create(open: DbOpener): Promise<DataStore>

  Create DataStore from an abstract-level opener function.

  Parameters

  • open: DbOpener

    Function that opens an abstract-level compatible key-value database with the given options.

  Returns Promise<DataStore>
• create<const A extends unknown[], const O extends {}>(
      ctor: DbCtor<A, O>,
      ...args: [...A[], O],
  ): Promise<DataStore>

  Create DataStore from an abstract-level subclass constructor.

  Type Parameters

  • const A extends unknown[]
  • const O extends {}

  Parameters

  • ctor: DbCtor<A, O>

    Subclass of abstract-level that accepts options as its last parameter.
  • ...args: [...A[], O]

    ctor arguments; last should be options object.

  Returns Promise<DataStore>