kist/ts/core/abstract/AbstractSingleton.ts

Package Pipeline Processor

// ============================================================================
// Abstract Singleton
// ============================================================================

/**
 * AbstractSingleton provides a base class for implementing singletons.
 * It ensures that only one instance of the derived class can exist.
 */
export abstract class AbstractSingleton<T extends AbstractSingleton<T>> {
    private static _instances = new Map<string, AbstractSingleton<any>>();

    protected constructor() {
        const className = this.constructor.name;
        if (AbstractSingleton._instances.has(className)) {
            throw new Error(
                `${className} is a singleton and has already been instantiated.`,
            );
        }
        AbstractSingleton._instances.set(className, this);
    }

    /**
     * Retrieves the singleton instance of the derived class.
     * If no instance exists, it initializes one.
     *
     * @returns The singleton instance.
     */
    public static getInstance<T extends AbstractSingleton<T>>(
        this: new () => T,
    ): T {
        const className = this.name;
        if (!AbstractSingleton._instances.has(className)) {
            AbstractSingleton._instances.set(className, new this());
        }
        return AbstractSingleton._instances.get(className) as T;
    }

    /**
     * Clears the singleton instance, useful for testing or resetting state.
     */
    public static clearInstance<T extends AbstractSingleton<T>>(
        this: new () => T,
    ): void {
        AbstractSingleton._instances.delete(this.name);
    }
}