/** * @module SharedLock */ import { type IReadableContext } from "../../../../execution-context/contracts/_module.js"; import { type ISharedLockFactoryResolver, type ISharedLockFactory, type ISharedLockAdapter } from "../../../../shared-lock/contracts/_module.js"; import { type SharedLockFactorySettingsBase } from "../../../../shared-lock/implementations/derivables/shared-lock-factory/_module.js"; import { type ITimeSpan } from "../../../../time-span/contracts/_module.js"; import { type Invocable } from "../../../../utilities/_module.js"; /** * IMPORT_PATH: `"@daiso-tech/core/shared-lock"` * @group Derivables */ export type SharedLockAdapters = Partial>; /** * Configuration for `SharedLockFactoryResolver`. * Registers named shared-lock adapters and optionally designates a default. * * IMPORT_PATH: `"@daiso-tech/core/shared-lock"` * @group Derivables */ export type SharedLockFactoryResolverSettings = SharedLockFactorySettingsBase & { /** * Named registry of shared-lock adapters. Each key is an adapter alias and the corresponding value is the adapter instance. */ adapters: SharedLockAdapters; /** * The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map. */ defaultAdapter?: NoInfer; }; /** * The `SharedLockFactoryResolver` class is immutable. * * IMPORT_PATH: `"@daiso-tech/core/shared-lock"` * @group Derivables */ export declare class SharedLockFactoryResolver implements ISharedLockFactoryResolver { private readonly settings; /** * @example * ```ts * import { SharedLockFactoryResolver } from "@daiso-tech/core/shared-lock"; * import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter"; * import { RedisSharedLockAdapter } from "@daiso-tech/core/shared-lock/redis-shared-lock-adapter"; * import { Serde } from "@daiso-tech/core/serde"; * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"; * import Redis from "ioredis" * * const serde = new Serde(new SuperJsonSerdeAdapter()); * const lockProviderFactory = new SharedLockFactoryResolver({ * serde, * adapters: { * memory: new MemorySharedLockAdapter(), * redis: new RedisSharedLockAdapter(new Redis("YOUR_REDIS_CONNECTION")), * }, * defaultAdapter: "memory", * }); * ``` */ constructor(settings: SharedLockFactoryResolverSettings); setCreateLockId(createId: Invocable<[], string>): SharedLockFactoryResolver; setDefaultTtl(ttl: ITimeSpan | null): SharedLockFactoryResolver; setDefaultRefreshTime(time: ITimeSpan): SharedLockFactoryResolver; setExecutionContext(context: IReadableContext): SharedLockFactoryResolver; /** * @example * ```ts * import { SharedLockFactoryResolver } from "@daiso-tech/core/shared-lock"; * import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter"; * import { RedisSharedLockAdapter } from "@daiso-tech/core/shared-lock/redis-shared-lock-adapter"; * import { Serde } from "@daiso-tech/core/serde"; * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"; * import { TimeSpan } from "@daiso-tech/core/time-span"; * import Redis from "ioredis"; * * const serde = new Serde(new SuperJsonSerdeAdapter()); * const lockProviderFactory = new SharedLockFactoryResolver({ * serde, * adapters: { * memory: new MemorySharedLockAdapter(), * redis: new RedisSharedLockAdapter(new Redis("YOUR_REDIS_CONNECTION")), * }, * defaultAdapter: "memory", * }); * * // Will acquire key using the default adapter which is MemorySharedLockAdapter * await lockProviderFactory * .use() * .create("a") * .acquireWriter(); * * // Will acquire key using the redis adapter * await lockProviderFactory * .use("redis") * .create("a") * .acquireWriter(); * ``` */ use(adapterName?: TAdapters | undefined): ISharedLockFactory; }