Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MongoProvider<TKey, TValue>

Use mongodb as a persistent storage mechanism

Type parameters

Hierarchy

  • MongoProvider

Implements

  • IStorageProvider<TKey, TValue>

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly isPersistable

isPersistable: true = true

Methods

delete

  • delete(key: TKey): Promise<boolean | IAgedValue<TValue>>

  • Parameters

    • key: TKey

      The key to the value to delete

    Returns Promise<boolean | IAgedValue<TValue>>

    The value deleted or boolean (value | true is success). A provider is not required to return a value

get

  • get(key: TKey): Promise<null | IAgedValue<TValue>>

  • Parameters

    • key: TKey

      The key to retrieve

    Returns Promise<null | IAgedValue<TValue>>

    The value if retreiving was successful or null

keys

  • keys(): Promise<TKey[]>

set

  • set(key: TKey, value: IAgedValue<TValue>): Promise<null | IAgedValue<TValue>>

  • Parameters

    • key: TKey

      The key to set

    • value: IAgedValue<TValue>

      The value to set

    Returns Promise<null | IAgedValue<TValue>>

    The value written if successful or null

size

  • size(): Promise<number>

Generated using TypeDoc