@elsikora/cladi/dist/esm/domain/interface/registry.interface.d.ts

ClaDI is a library for creating and managing classes in TypeScript.

/**
 * Generic registry interface for managing items by name.
 * @template T The type of items stored in the registry.
 * @see {@link https://elsikora.com/docs/cladi/core-concepts/registry}
 */
export interface IRegistry<T> {
    /**
     * Clear the registry.
     */
    clear(): void;
    /**
     * Get a single item from the registry by name.
     * @param name The name of the item to get.
     * @returns The item or undefined if it doesn't exist.
     */
    get(name: string): T | undefined;
    /**
     * Get all items from the registry.
     * @returns An array of all items.
     */
    getAll(): Array<T>;
    /**
     * Get multiple items from the registry by their names.
     * @param names The names of the items to get.
     * @returns An array of items.
     */
    getMany(names: Array<string>): Array<T>;
    /**
     * Check if an item exists in the registry by name.
     * @param name The name of the item to check.
     * @returns True if the item exists, false otherwise.
     */
    has(name: string): boolean;
    /**
     * Register a single item in the registry.
     * @param item The item to register.
     */
    register(item: T): void;
    /**
     * Register multiple items in the registry.
     * @param items The items to register.
     */
    registerMany(items: Array<T>): void;
    /**
     * Unregister a single item from the registry by name.
     * @param name The name of the item to unregister.
     */
    unregister(name: string): void;
    /**
     * Unregister multiple items from the registry by their names.
     * @param names The names of the items to unregister.
     */
    unregisterMany(names: Array<string>): void;
}
//# sourceMappingURL=registry.interface.d.ts.map