Class LoadNCache<T>

The main class of this project. Check README.md for documentation.

Type Parameters

Hierarchy

EventEmitter
- LoadNCache

Index

Constructors

constructor

new LoadNCache<T>(cfg: Configuration<T> | (() => Promise<T>)): LoadNCache<T>
The LoadNCache constructor accept an options object. If default options are ok for you then you can pass in a function. Passing a function is equivalent to passing only the loader option in the options parameter.
Type Parameters
- T
Parameters
- cfg: Configuration<T> | (() => Promise<T>)
  
  Instance settings or a load function.
Returns LoadNCache<T>
Overrides EventEmitter.constructor
- Defined in src/LoadNCache.ts:61

Properties

`Private` `Optional` `Readonly` autoflushManager

autoflushManager?: AutoflushManager<T>

AutoflushManager casted to right type.

`Private` `Readonly` config

config: Configuration<T>

The actual configuration including defaults.

`Private` firstLoad

firstLoad: boolean = true

Is this the first time we load a value?

`Private` `Optional` metadata

metadata?: PromiseWithMetadata<T>

Metadata associated to the promise below.

`Private` `Readonly` persistenceManager

persistenceManager: PersistenceManager<T>

Persistence manager casted to right type.

`Private` `Optional` promise

promise?: Promise<T>

The promise holding the value.

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): LoadNCache<T>
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LoadNCache<T>
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

`Private` callLoadFunction

callLoadFunction(): Promise<T>
Invoke the loadFunction ensuring that its returned value is a promise. The check is ensured implicitly by using the async qualifier.

Returns Promise<T>
- Defined in src/LoadNCache.ts:107

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

flush

flush(): Promise<void>
Invalidate the currently cached value if any. If no value is cached then this method does nothing. Each subsequent call to .get() will get a different promise object then before.

Returns Promise<void>
- Defined in src/LoadNCache.ts:216

get

get(): Promise<T>
Retrieve the value. Always returns a promise. This call will result in the invocation of loadFunction if no cached value is available at the time.

Returns
A promise that will be resolved with the value or reject if fetching fails.

Returns Promise<T>
- Defined in src/LoadNCache.ts:184

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

`Private` loadNewValue

loadNewValue(): Promise<PromiseWithMetadata<T>>
This method load a new value from storage or by calling a loadFunction. As soon as the value is available (which can be also a rejected promise) its stored as a promise along with the timestamp.

Returns Promise<PromiseWithMetadata<T>>
- Defined in src/LoadNCache.ts:116

off

off<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): LoadNCache<T>
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns LoadNCache<T>
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): LoadNCache<T>
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LoadNCache<T>
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): LoadNCache<T>
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LoadNCache<T>
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

`Private` prepareFlushCbFor

prepareFlushCbFor(metadata: PromiseWithMetadata<T>): (() => void)
Returns a new flush callback.

Returns
the callback function.
Parameters
- metadata: PromiseWithMetadata<T>
  
  The object that this callback will flush.
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/LoadNCache.ts:171

refresh

refresh(): Promise<T>
Shortcut for calling .flush() and .get(). Returns the promise from .get().

Returns
the same promise that .get() would return.

Returns Promise<T>
- Defined in src/LoadNCache.ts:238

removeAllListeners

removeAllListeners(event?: string | symbol): LoadNCache<T>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns LoadNCache<T>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): LoadNCache<T>
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns LoadNCache<T>
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

`Private` safelyCallClear

safelyCallClear(): Promise<void>
Calls the persistenceManager clear method handling exceptions.

Returns Promise<void>
- Defined in src/LoadNCache.ts:158

`Private` safelyCallPersist

safelyCallPersist(promise: PromiseWithMetadata<T>): Promise<void>
Calls the persistenceManager saveValue method handling exceptions.
Parameters
- promise: PromiseWithMetadata<T>
  
  The PromiseWithMetadata object that stores the data to persist.
Returns Promise<void>
- Defined in src/LoadNCache.ts:146

Class LoadNCache<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

cfg: Configuration<T> | (() => Promise<T>)

Returns LoadNCache<T>

Properties

Private Optional Readonly autoflushManager

Private Readonly config

Private firstLoad

Private Optional metadata

Private Readonly persistenceManager

Private Optional promise

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns LoadNCache<T>

Private callLoadFunction

Returns Promise<T>

emit

Type Parameters

T extends string | symbol

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

flush

Returns Promise<void>

get

Returns

Returns Promise<T>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

Returns ((...args: any[]) => void)[]

Private loadNewValue

Returns Promise<PromiseWithMetadata<T>>

off

Type Parameters

T extends string | symbol

Parameters

event: T

Optional fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Optional once: boolean

Returns LoadNCache<T>

on

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

`Private` `Optional` `Readonly` autoflushManager

`Private` `Readonly` config

`Private` firstLoad

`Private` `Optional` metadata

`Private` `Readonly` persistenceManager

`Private` `Optional` promise

`Rest` ...args: any[]

`Optional` context: any

`Private` callLoadFunction

`Rest` ...args: any[]

`Private` loadNewValue

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Private` prepareFlushCbFor

`Optional` event: string | symbol

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Private` safelyCallClear

`Private` safelyCallPersist