All files / src/services ServiceLocator.ts

6.25% Statements 1/16
0% Branches 0/4
0% Functions 0/5
6.25% Lines 1/16

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86                  1x                                                                                                                                                        
// SPDX-License-Identifier: Apache-2.0
 
import { IService } from './IService';
 
/**
 * ServiceLocator is a class that manages services in the application.
 * It provides methods to register, unregister, and get services.
 * It implements the Singleton pattern, meaning there can only be one instance of this class in the application.
 */
export class ServiceLocator {
    /**
     * A map of services registered with the service locator.
     * The key is the service name and the value is the service instance.
     * 
     * @private
     */
    private services: Map<string,IService> = new Map<string, IService>();
 
    /**
     * The current instance of the service locator.
     * 
     * @private
     */
    private static currentInstance: ServiceLocator;
 
    /**
     * Gets the current instance of the ServiceLocator.
     * If the current instance does not exist, it creates a new one.
     * 
     * @public
     * @returns {ServiceLocator} The current instance of the ServiceLocator.
     */
    public static get Current(): ServiceLocator {
        Iif (!ServiceLocator.currentInstance) {
            this.currentInstance = new ServiceLocator();
        }
        
        return this.currentInstance
    }
 
    /**
     * Gets a service registered with the service locator.
     * 
     * @param {string} serviceName - The name of the service to get.
     * @returns {T} The service instance.
     * @throws {Error} If the service is not registered with the service locator.
     */
    public get<T extends IService>(serviceName: string): T {
        Iif (!this.services.has(serviceName)) {
          throw new Error(`${serviceName} not registered with ${this.constructor.name}`);
        }
    
        return this.services.get(serviceName) as T;
    }
 
    /**
     * Registers a service with the service locator.
     * 
     * @param {T} service - The service instance to register.
     * @throws {Error} If the service is already registered with the service locator.
     */
    public register<T extends IService>(service: T): void {
        const key: string = service.constructor.name;
        Iif (this.services.has(key)) {
            throw new Error(`${key} not registered with ${this.constructor.name}`);
        }
 
        this.services.set(key, service);
    }
 
    /**
     * Unregisters a service from the service locator.
     * 
     * @public
     * @param {string} serviceName - The name of the service to unregister.
     */
    public unregister(serviceName: string): void {
        Iif (!this.services.has(serviceName)) {
            console.error(`Attempted to unregister service of type ${serviceName} which is not registered with ${this.constructor.name}.`);
            return;
        }
 
        this.services.delete(serviceName);
    }
}