Class Cache<PrimaryType>

Type Parameters

PrimaryType extends Dictionary<any>

Index

Constructors

Properties

limit resolver storage defaultLimit

Methods

Constructors

constructor

new Cache<PrimaryType>(options?): Cache<PrimaryType>
Creates a Cache
Type Parameters
- PrimaryType extends Dictionary<any>
Parameters
- options: Partial<CacheOptions<PrimaryType>> = {}
Returns Cache<PrimaryType>
- Defined in src/classes/cache.ts:39

Properties

`Private` limit

limit: number = Cache.defaultLimit

The maximum amount of documents that can be storage before erasure.

`Private` resolver

resolver: ((storedData, newData) => boolean) = Object.is

The method to use in determining data equality

Type declaration

- (storedData, newData): boolean
- The method to use in determining data equality
  Parameters
  - storedData: undefined | null | PrimaryType | PrimaryType[]
  - newData: undefined | null | PrimaryType | PrimaryType[]
  Returns boolean

`Private` `Internal` storage

storage: [nullish | SingleOrArray<PrimaryType>, undefined | Partial<SerializerOptions<PrimaryType>>, Partial<DataDocument<PrimaryType>>][] = []

The storage for the cache

`Static` defaultLimit

defaultLimit: number = 10

The default max for document storage

Methods

get

get(data, options?): false | Partial<DataDocument<PrimaryType>>
Internal
Gets a document in the cache
Parameters
- data: nullish | SingleOrArray<PrimaryType>
- Optional options: Partial<SerializerOptions<PrimaryType>>
Returns false | Partial<DataDocument<PrimaryType>>
- Defined in src/classes/cache.ts:45

set

set(data, document, options?): Partial<DataDocument<PrimaryType>>
Internal
Sets a document in the cache
Parameters
- data: nullish | SingleOrArray<PrimaryType>
- document: Partial<DataDocument<PrimaryType>>
- Optional options: Partial<SerializerOptions<PrimaryType>>
Returns Partial<DataDocument<PrimaryType>>
- Defined in src/classes/cache.ts:58

Generated using TypeDoc