@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.
98 lines (97 loc) • 4 kB
TypeScript
/**
* @module Lock
*/
import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
import { type ILockProviderFactory, type ILockProvider, type LockAdapterVariants } from "../../../../lock/contracts/_module.js";
import { type LockProviderSettingsBase } from "../../../../lock/implementations/derivables/lock-provider/_module.js";
import { type Namespace } from "../../../../namespace/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type Invokable } from "../../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockAdapters<TAdapters extends string> = Partial<Record<TAdapters, LockAdapterVariants>>;
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockProviderFactorySettings<TAdapters extends string> = LockProviderSettingsBase & {
adapters: LockAdapters<TAdapters>;
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `LockProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export declare class LockProviderFactory<TAdapters extends string> implements ILockProviderFactory<TAdapters> {
private readonly settings;
/**
* @example
* ```ts
* import { LockProviderFactory } 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 lockProviderFactory = new LockProviderFactory({
* serde,
* adapters: {
* memory: new MemoryLockAdapter(),
* redis: new RedisLockAdapter(new Redis("YOUR_REDIS_CONNECTION")),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: LockProviderFactorySettings<TAdapters>);
setNamespace(namespace: Namespace): LockProviderFactory<TAdapters>;
setCreateLockId(createId: Invokable<[], string>): LockProviderFactory<TAdapters>;
setEventBus(eventBus: IEventBus): LockProviderFactory<TAdapters>;
setDefaultTtl(ttl: ITimeSpan): LockProviderFactory<TAdapters>;
setDefaultBlockingInterval(interval: ITimeSpan): LockProviderFactory<TAdapters>;
setDefaultBlockingTime(time: ITimeSpan): LockProviderFactory<TAdapters>;
setDefaultRefreshTime(time: ITimeSpan): LockProviderFactory<TAdapters>;
/**
* @example
* ```ts
* import { LockProviderFactory } 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" from "@daiso-tech/core/time-span";
* import Redis from "ioredis";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const lockProviderFactory = new LockProviderFactory({
* 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 lockProviderFactory
* .use()
* .create("a")
* .acquire();
*
* // Will acquire key using the redis adapter
* await lockProviderFactory
* .use("redis")
* .create("a")
* .acquire();
* ```
*/
use(adapterName?: TAdapters | undefined): ILockProvider;
}