Class Var<T>Abstract

bucket

key

delete

• delete(): Promise<undefined | Entry<T>>

• Deletes the key from the database

  Returns Promise<undefined | Entry<T>>

  The deleted entry, or undefined if none

get

• get(): Promise<undefined | Entry<T>>

• Fetches the current value

  Returns Promise<undefined | Entry<T>>

  The entry, or undefined if it did not exist

set

• set(value, options?): Promise<Entry<T>>

• Store a value at the provided key in the bucket, this will overwrite the previous value stored there, if any.

  Parameters

  • value: T

    The value you're storing, for objects this will be converted to json behind the scenes

  • Optional options: SetValueOptions

    Optional options

  Returns Promise<Entry<T>>

  The storage entry

setIf

• setIf(value, cond, options?): Promise<undefined | Entry<T>>

• Similar to set but stores the value conditionally.

  Parameters

  • value: T

    The value you're storing, for objects this will be converted to json behind the scenes

  • cond: "IfExists" | "IfNotExists"

    The condition that has to pass to store the value.

    • IfExists: will only store the value if the key existed beforehand.
    • IfNotExists: will only store the value if the key did not exist.

  • Optional options: SetValueOptions

    Optional options

  Returns Promise<undefined | Entry<T>>

  Either the new entry, or undefined if the condition failed.