Class Cache<T>

An abstraction for prioritizing performance over data "freshness"

Type Parameters

  • T

Implements

Constructors

constructor

Properties

cacheLife serializer storage

Methods

Add Delete Get cacheIsValid

Constructors

constructor

  • new Cache<T>(storage, cacheLife?, serializer?): Cache<T>

  • Type Parameters

    • T

    Parameters

    • storage: IGenericStorage

      the storage interface used to support caching

    • cacheLife: number | ((entry) => boolean) = 0

      EITHER 1.) the amount of milliseconds after the cache is created till it is invalidated | leaving the default value (0) will result prevent any auto clearing of cache entries OR 2.) a function defining when the cache is no longer valid; a "false" return will invalidate the cache

    • serializer: JsonSerializer = ...

    Returns Cache<T>

Properties

Private cacheLife

cacheLife: number | ((entry) => boolean) = 0

EITHER 1.) the amount of milliseconds after the cache is created till it is invalidated | leaving the default value (0) will result prevent any auto clearing of cache entries OR 2.) a function defining when the cache is no longer valid; a "false" return will invalidate the cache

Type declaration

    • (entry): boolean

    • Parameters

      • entry: T

      Returns boolean

Private serializer

serializer: JsonSerializer = ...

Private storage

storage: IGenericStorage

the storage interface used to support caching

Methods

Add

Delete

Get

  • Get(key, type?): null | T

  • Get the value cached at the given key | returns null when there is no value for the given key

    Parameters

    • key: string
    • Optional type: (new () => T)
        • new (): T

        • Returns T

    Returns null | T

Private cacheIsValid

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc