Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncKeyValueRWTransaction

Represents an asynchronous read-write transaction.

Hierarchy

Index

Methods

Methods

abort

commit

del

get

put

  • put(key: string, data: Buffer, overwrite: boolean, cb: function): void
  • Adds the data to the store under the given key. Overwrites any existing data.

    Parameters

    • key: string

      The key to add the data under.

    • data: Buffer

      The data to add to the store.

    • overwrite: boolean

      If 'true', overwrite any existing data. If 'false', avoids writing the data if the key exists.

    • cb: function

      Triggered with an error and whether or not the value was committed.

        • (e: ApiError, committed?: undefined | true | false): void
        • Parameters

          • e: ApiError
          • Optional committed: undefined | true | false

          Returns void

    Returns void

Generated using TypeDoc