Class: Singleton#

Common.Util.Singleton

Table of contents#

• new Singleton()

▸ Static createInstance<T, R>(this, ...args): T

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.

Name	Type
`T`	`T`
`R`	extends `any`[]

Name	Type	Description
`this`	`StaticThis`<`T`, `R`>	Implicit argument that is the child class type
`...args`	`R`	The constructor arguments for the child class

T

An instance of the child class

▸ Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

Name	Type
`T`	`T`
`R`	extends `any`[]

Name	Type	Description
`this`	`StaticThis`<`T`, `R`>	Implicit argument that is the child class type
`strict?`	`true`	If false will return `undefined` instead of throwing when an instance doesn't exist. Default: `true`

T

An instance of the child class

▸ Static getInstance<T, R>(this, strict): undefined | T

Name	Type
`T`	`T`
`R`	extends `any`[]

Name	Type
`this`	`StaticThis`<`T`, `R`>
`strict`	`false`

undefined | T

▸ Static resetInstance(): void

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.

void