@daiso-tech/core/dist/lock/contracts/lock-factory-resolver.contract.d.ts

The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.

/**
 * @module Lock
 */
import { type ILockFactory } from "../../lock/contracts/lock-factory.contract.js";
/**
 * Factory resolver contract for dynamically selecting lock factory implementations.
 * Enables seamless switching between different storage backends and adapters at runtime.
 * Implementations typically use adapter registration patterns to manage multiple implementations.
 *
 * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
 * @group Contracts
 */
export type ILockFactoryResolver<TAdapters extends string = string> = {
    /**
     * Selects and returns a lock factory implementation.
     * If an adapter name is provided, that specific implementation is returned.
     * If no name is provided, the default registered adapter is used.
     *
     * @param adapterName - Optional name of a registered adapter implementation
     * @returns The selected lock factory
     * @throws {UnregisteredAdapterError} If the specified adapter name is not registered
     * @throws {DefaultAdapterNotDefinedError} If no adapter name is provided and no default adapter is configured
     */
    use(adapterName?: TAdapters): ILockFactory;
};