Class: Singleton#
Hierarchy#
- Singleton
Index#
Constructors#
Methods#
Constructors#
constructor#
+ new Singleton(): Singleton
Defined in src/common/utils/singleton.ts:26
Returns: Singleton
Methods#
Static createInstance#
▸ createInstance‹T, R›(this: StaticThis‹T, R›, ...args: R): T
Defined in src/common/utils/singleton.ts:46
Creates the single instance of the child class if one was not already created.
Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.
Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.
Type parameters:
▪ T
▪ R: any[]
Parameters:
| Name | Type | Description |
|---|---|---|
this |
StaticThis‹T, R› | Implicit argument that is the child class type |
...args |
R | The constructor arguments for the child class |
Returns: T
An instance of the child class
Static getInstance#
▸ getInstance‹T, R›(this: StaticThis‹T, R›, strict: boolean): T | undefined
Defined in src/common/utils/singleton.ts:67
Get the instance of the child class that was previously created.
Type parameters:
▪ T
▪ R: any[]
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
this |
StaticThis‹T, R› | - | Implicit argument that is the child class type |
strict |
boolean | true | If false will return undefined instead of throwing when an instance doesn't exist. Default: true |
Returns: T | undefined
An instance of the child class
Static resetInstance#
▸ resetInstance(): void
Defined in src/common/utils/singleton.ts:82
Delete the instance of the child class.
Note: this doesn't prevent callers of getInstance from storing the result in a global.
There is no way in JS or TS to prevent globals like that.
Returns: void