/** * @module Lock */ import { type IReadableContext } from "../../../../execution-context/contracts/_module.js"; import { type ILockFactoryResolver, type ILockFactory, type ILockAdapter } from "../../../../lock/contracts/_module.js"; import { type LockFactorySettingsBase } from "../../../../lock/implementations/derivables/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/lock"` * @group Derivables */ export type LockAdapters = Partial>; /** * Configuration for `LockFactoryResolver`. * Registers named lock adapters and optionally designates a default. * * IMPORT_PATH: `"@daiso-tech/core/lock"` * @group Derivables */ export type LockFactoryResolverSettings = LockFactorySettingsBase & { /** * Named registry of lock adapters. Each key is an adapter alias and the corresponding value is the adapter instance. */ adapters: LockAdapters; /** * The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map. */ defaultAdapter?: NoInfer; }; /** * The `LockFactoryResolver` class is immutable. * * IMPORT_PATH: `"@daiso-tech/core/lock"` * @group Derivables */ export declare class LockFactoryResolver implements ILockFactoryResolver { private readonly settings; /** * @example * ```ts * import { LockFactoryResolver } from "@daiso-tech/core/lock"; * import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter"; * import { RedisLockAdapter } from "@daiso-tech/core/lock/redis-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 lockFactoryResolver = new LockFactoryResolver({ * serde, * adapters: { * memory: new MemoryLockAdapter(), * redis: new RedisLockAdapter(new Redis("YOUR_REDIS_CONNECTION")), * }, * defaultAdapter: "memory", * }); * ``` */ constructor(settings: LockFactoryResolverSettings); setCreateLockId(createId: Invocable<[], string>): LockFactoryResolver; setDefaultTtl(ttl: ITimeSpan | null): LockFactoryResolver; setDefaultRefreshTime(time: ITimeSpan): LockFactoryResolver; setExecutionContext(context: IReadableContext): LockFactoryResolver; /** * @example * ```ts * import { LockFactoryResolver } from "@daiso-tech/core/lock"; * import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter"; * import { RedisLockAdapter } from "@daiso-tech/core/lock/redis-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 lockFactoryResolver = new LockFactoryResolver({ * serde, * adapters: { * memory: new MemoryLockAdapter(), * redis: new RedisLockAdapter(new Redis("YOUR_REDIS_CONNECTION")), * }, * defaultAdapter: "memory", * }); * * // Will acquire key using the default adapter which is MemoryLockAdapter * await lockFactoryResolver * .use() * .create("a") * .acquire(); * * // Will acquire key using the redis adapter * await lockFactoryResolver * .use("redis") * .create("a") * .acquire(); * ``` */ use(adapterName?: TAdapters | undefined): ILockFactory; }