@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
106 lines (105 loc) • 4.48 kB
TypeScript
/**
* @module Lock
*/
import { type EventBusInput } from "../../../../event-bus/contracts/_module.js";
import { type IExecutionContext } from "../../../../execution-context/contracts/_module.js";
import { type ILockFactoryResolver, type ILockFactory, type LockAdapterVariants } from "../../../../lock/contracts/_module.js";
import { type LockFactorySettingsBase } from "../../../../lock/implementations/derivables/lock-factory/_module.js";
import { type INamespace } from "../../../../namespace/contracts/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type Invokable, type WaitUntil } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockAdapters<TAdapters extends string> = Partial<Record<TAdapters, LockAdapterVariants>>;
/**
* Configuration for `LockFactoryResolver`.
* Registers named lock adapters and optionally designates a default.
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockFactoryResolverSettings<TAdapters extends string> = LockFactorySettingsBase & {
/**
* Named registry of lock adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
*/
adapters: LockAdapters<TAdapters>;
/**
* The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map.
*/
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `LockFactoryResolver` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export declare class LockFactoryResolver<TAdapters extends string> implements ILockFactoryResolver<TAdapters> {
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<TAdapters>);
setNamespace(namespace: INamespace): LockFactoryResolver<TAdapters>;
setCreateLockId(createId: Invokable<[], string>): LockFactoryResolver<TAdapters>;
setEventBus(eventBus: EventBusInput): LockFactoryResolver<TAdapters>;
setDefaultTtl(ttl: ITimeSpan | null): LockFactoryResolver<TAdapters>;
setDefaultRefreshTime(time: ITimeSpan): LockFactoryResolver<TAdapters>;
setWaitUntil(waitUntil: WaitUntil): LockFactoryResolver<TAdapters>;
setExecutionContext(executionContext: IExecutionContext): LockFactoryResolver<TAdapters>;
/**
* @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;
}