Class default<T, R>

Represents a class that can be used to create a singleton instance of a class that is created asynchronously.

Type Parameters

T
R

Index

Constructors

Methods

clear getValue instance

Constructors

constructor

new default<T, R>(factory, checker?): default<T, R>
Creates a new instance of the AsyncSingleton class.
Type Parameters
- T
- R
Parameters
- factory: ((r: R) => Promise<T>)
  The factory function that creates the instance.
  - - (r): Promise<T>
    - Parameters
      r: R
      Returns Promise<T>
- checker: ((value: T) => Promise<boolean>) = ...
  The function that checks if the instance is valid.
  - - (value): Promise<boolean>
    - Parameters
      value: T
      Returns Promise<boolean>
Returns default<T, R>
- Defined in src/Util/AsyncSingleton.ts:20

Methods

clear

clear(): void
Clears the current value and rejects all pending promises.

Returns void
- Defined in src/Util/AsyncSingleton.ts:52

getValue

getValue(): undefined | T
Gets the current value, may be undefined or invalid.

Returns undefined | T
- Defined in src/Util/AsyncSingleton.ts:45

instance

instance(r): Promise<T>
Gets the instance of the class.
Parameters
- r: R
  The configuration object for creating the instance.
Returns Promise<T>
- Defined in src/Util/AsyncSingleton.ts:32