Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MongooseProvider<TKey, TValue>

Use mongodb as a persistent storage mechanism with Mongoose documents

Type parameters

  • TKey = Types.ObjectId

  • TValue: Document = Document

Hierarchy

  • MongooseProvider

Implements

  • IStorageProvider<TKey, TValue>

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly isPersistable

isPersistable: true = true

Private Readonly keyProperty

keyProperty: string = ...

Private Readonly logger

logger: Logger = ...

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

Private execIgnoreError

  • execIgnoreError<TResult>(query: Query<null | TResult, EnforceDocument<TValue, Record<string, never>>, {}, EnforceDocument<TValue, Record<string, never>>>): Promise<null | TResult>

  • Type parameters

    • TResult

    Parameters

    • query: Query<null | TResult, EnforceDocument<TValue, Record<string, never>>, {}, EnforceDocument<TValue, Record<string, never>>>

    Returns Promise<null | TResult>

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

Private getAgedValue

  • getAgedValue(value: TValue): { age: number; value: TValue }

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>

Private updateRecordAge

  • updateRecordAge(value: IAgedValue<TValue>): void

Generated using TypeDoc