Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncBaseStorage

Prescribes a common interface of asynchronous string-value KVS.

Hierarchy

  • AsyncBaseStorage

Index

Methods

Methods

get

  • get(key: string): Promise<null | string>

  • Retrieves the value associated with the specified key asynchronously.

    Returns null if the key is not found.

    Parameters

    • key: string

      key to retrieve

    Returns Promise<null | string>

remove

  • remove(key: string): Promise<void>

  • Removes the key and its value asynchronously.

    Parameters

    • key: string

      key to remove

    Returns Promise<void>

set

  • set(key: string, value: string): Promise<void>

  • Associates the value with the key, then store the key-value pair asynchronously.

    Parameters

    • key: string

      key to store

    • value: string

      value to be associated with key

    Returns Promise<void>

Generated using TypeDoc