@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.
207 lines (206 loc) • 8.56 kB
TypeScript
/**
* @module Lock
*/
import { type EventListener, type IEventBus, type Unsubscribe } from "../../../../event-bus/contracts/_module.js";
import { type ILock, type LockProviderCreateSettings, type ILockProvider, type LockAdapterVariants, type LockEventMap } from "../../../../lock/contracts/_module.js";
import { Namespace } from "../../../../namespace/_module.js";
import { type ISerderRegister } from "../../../../serde/contracts/_module.js";
import { type ITask } from "../../../../task/contracts/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type OneOrMore, type Invokable } from "../../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockProviderSettingsBase = {
/**
* @default
* ```ts
* import { Namespace } from "@daiso-tech/core/namespace";
*
* new Namespace("@lock")
* ```
*/
namespace?: Namespace;
serde?: OneOrMore<ISerderRegister>;
/**
* @default ""
*/
serdeTransformerName?: string;
/**
* You can pass your lock id id generator function.
* @default
* ```ts
* import { v4 } from "uuid";
*
* () => v4
*/
createLockId?: Invokable<[], string>;
/**
* @default
* ```ts
* import { EventBus } from "@daiso-tech/core/event-bus";
* import { NoOpEventBusAdapter } from "@daiso-tech/core/event-bus/no-op-event-bus-adapter";
*
* new EventBus({
* adapter: new NoOpEventBusAdapter()
* })
* ```
*/
eventBus?: IEventBus;
/**
* You can decide the default ttl value for {@link ILock | `ILock`} expiration. If null is passed then no ttl will be used by default.
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMinutes(5);
* ```
*/
defaultTtl?: ITimeSpan | null;
/**
* The default refresh time used in the {@link ILock | `ILock`} `acquireBlocking` and `runBlocking` methods.
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromSeconds(1);
* ```
*/
defaultBlockingInterval?: ITimeSpan;
/**
* The default refresh time used in the {@link ILock | `ILock`} `acquireBlocking` and `runBlocking` methods.
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMinutes(1);
* ```
*/
defaultBlockingTime?: ITimeSpan;
/**
* The default refresh time used in the {@link ILock | `ILock`} `referesh` method.
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMinutes(5);
* ```
*/
defaultRefreshTime?: ITimeSpan;
};
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockProviderSettings = LockProviderSettingsBase & {
adapter: LockAdapterVariants;
};
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export declare const DEFAULT_LOCK_PROVIDER_NAMESPACE: Namespace;
/**
* `LockProvider` class can be derived from any {@link ILockAdapter | `ILockAdapter`} or {@link IDatabaseLockAdapter | `IDatabaseLockAdapter`}.
*
* Note the {@link ILock | `ILock`} instances created by the `LockProvider` class are serializable and deserializable,
* allowing them to be seamlessly transferred across different servers, processes, and databases.
* This can be done directly using {@link ISerderRegister | `ISerderRegister`} or indirectly through components that rely on {@link ISerderRegister | `ISerderRegister`} internally.
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export declare class LockProvider implements ILockProvider {
private readonly eventBus;
private readonly originalAdapter;
private readonly adapter;
private readonly namespace;
private readonly creatLockId;
private readonly defaultTtl;
private readonly defaultBlockingInterval;
private readonly defaultBlockingTime;
private readonly defaultRefreshTime;
private readonly serde;
private readonly serdeTransformerName;
/**
* @example
* ```ts
* import { KyselyLockAdapter } from "@daiso-tech/core/lock/kysely-lock-adapter";
* import { LockProvider } from "@daiso-tech/core/lock";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import Sqlite from "better-sqlite3";
* import { Kysely, SqliteDialect } from "kysely";
*
* const lockAdapter = new KyselyLockAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* });
* });
* // You need initialize the adapter once before using it.
* await lockAdapter.init();
*
* const serde = new Serde(new SuperJsonSerdeAdapter())
* const lockProvider = new LockProvider({
* serde,
* adapter: lockAdapter,
* });
* ```
*/
constructor(settings: LockProviderSettings);
private registerToSerde;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
addListener<TEventName extends keyof LockEventMap>(eventName: TEventName, listener: EventListener<LockEventMap[TEventName]>): ITask<void>;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
removeListener<TEventName extends keyof LockEventMap>(eventName: TEventName, listener: EventListener<LockEventMap[TEventName]>): ITask<void>;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
listenOnce<TEventName extends keyof LockEventMap>(eventName: TEventName, listener: EventListener<LockEventMap[TEventName]>): ITask<void>;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
asTask<TEventName extends keyof LockEventMap>(eventName: TEventName): ITask<LockEventMap[TEventName]>;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
subscribeOnce<TEventName extends keyof LockEventMap>(eventName: TEventName, listener: EventListener<LockEventMap[TEventName]>): ITask<Unsubscribe>;
/**
* You can listen to the following {@link LockEventMap | `LockEventMap`} of all {@link ILock | `ILock`} instances created by the {@link ILockProvider | `ILockProvider`}.
* To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
*/
subscribe<TEventName extends keyof LockEventMap>(eventName: TEventName, listener: EventListener<LockEventMap[TEventName]>): ITask<Unsubscribe>;
/**
* @example
* ```ts
* import { LockProvider } from "@daiso-tech/core/lock";
* import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter";
* import { Namespace } from "@daiso-tech/core/namespace";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
*
* const lockProvider = new LockProvider({
* adapter: new MemoryLockAdapter(),
* namespace: new Namespace("lock"),
* serde: new Serde(new SuperJsonSerdeAdapter())
* });
*
* const lock = lockProvider.create("a");
* ```
*/
create(key: string, settings?: LockProviderCreateSettings): ILock;
}