@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.83 kB
TypeScript
/**
* @module SharedLock
*/
import { type EventBusInput } from "../../../../event-bus/contracts/_module.js";
import { type IExecutionContext } from "../../../../execution-context/contracts/_module.js";
import { type INamespace } from "../../../../namespace/contracts/_module.js";
import { type ISharedLockFactoryResolver, type ISharedLockFactory, type SharedLockAdapterVariants } 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 Invokable, type WaitUntil } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/shared-lock"`
* @group Derivables
*/
export type SharedLockAdapters<TAdapters extends string> = Partial<Record<TAdapters, SharedLockAdapterVariants>>;
/**
* 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<TAdapters extends string> = SharedLockFactorySettingsBase & {
/**
* Named registry of shared-lock adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
*/
adapters: SharedLockAdapters<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 `SharedLockFactoryResolver` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/shared-lock"`
* @group Derivables
*/
export declare class SharedLockFactoryResolver<TAdapters extends string> implements ISharedLockFactoryResolver<TAdapters> {
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<TAdapters>);
setNamespace(namespace: INamespace): SharedLockFactoryResolver<TAdapters>;
setCreateLockId(createId: Invokable<[], string>): SharedLockFactoryResolver<TAdapters>;
setEventBus(eventBus: EventBusInput): SharedLockFactoryResolver<TAdapters>;
setDefaultTtl(ttl: ITimeSpan | null): SharedLockFactoryResolver<TAdapters>;
setDefaultRefreshTime(time: ITimeSpan): SharedLockFactoryResolver<TAdapters>;
setWaitUntil(waitUntil: WaitUntil): SharedLockFactoryResolver<TAdapters>;
setExecutionContext(executionContext: IExecutionContext): SharedLockFactoryResolver<TAdapters>;
/**
* @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;
}