@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.
143 lines (142 loc) • 5.78 kB
TypeScript
/**
* @module Lock
*/
import type { IEventBus } from "../../../../event-bus/contracts/_module-exports.js";
import type { ILockProviderFactory, ILockProvider } from "../../../../lock/contracts/_module-exports.js";
import { KeyPrefixer } from "../../../../utilities/_module-exports.js";
import type { AsyncLazy, Factory, TimeSpan } from "../../../../utilities/_module-exports.js";
import { type LockAdapter, type LockProviderSettingsBase } from "../../../../lock/implementations/derivables/lock-provider/_module.js";
import type { LazyPromise } from "../../../../async/_module-exports.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export type LockAdapters<TAdapters extends string> = Partial<Record<TAdapters, LockAdapter>>;
/**
*
* 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 type { IDatabaseLockAdapter } from "@daiso-tech/core/lock/contracts";
* import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/lock/adapters";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
* import { KeyPrefixer, type ISqliteDatabase, type AsyncFactoryFn } from "@daiso-tech/core/utilities";
* import Redis from "ioredis"
* import Sqlite from "better-sqlite3";
*
* function lockAdapterFactory(database: ISqliteDatabase): AsyncFactoryFn<string, IDatabaseLockAdapter> {
* return async (prefix) => {
* const lockAdapter = new SqliteLockAdapter({
* database,
* tableName: `lock_${prefix}`
* });
* await lockAdapter.init();
* return lockAdapter;
* }
* }
*
* const database = new Sqlite("local.db");
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const lockProviderFactory = new LockProviderFactory({
* serde,
* keyPrefixer: new KeyPrefixer("lock"),
* adapters: {
* sqlite: lockAdapterFactory(database),
* memory: new MemoryLockAdapter(),
* redis: new RedisLockAdapter({
* client: new Redis("YOUR_REDIS_CONNECTION"),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: LockProviderFactorySettings<TAdapters>);
setKeyPrefixer(keyPrefixer: KeyPrefixer): LockProviderFactory<TAdapters>;
setCreateOwnerId(createId: () => string): LockProviderFactory<TAdapters>;
setEventBus(eventBus: IEventBus): LockProviderFactory<TAdapters>;
setDefaultTtl(ttl: TimeSpan): LockProviderFactory<TAdapters>;
setDefaultBlockingInterval(interval: TimeSpan): LockProviderFactory<TAdapters>;
setDefaultBlockingTime(time: TimeSpan): LockProviderFactory<TAdapters>;
setDefaultRefreshTime(time: TimeSpan): LockProviderFactory<TAdapters>;
setLazyPromiseFactory(factory: Factory<AsyncLazy<any>, LazyPromise<any>>): LockProviderFactory<TAdapters>;
/**
* @example
* ```ts
* import { LockProviderFactory } from "@daiso-tech/core/lock";
* import type { IDatabaseLockAdapter } from "@daiso-tech/core/lock/contracts";
* import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/lock/adapters";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
* import { KeyPrefixer, TimeSpan, type ISqliteDatabase, type AsyncFactoryFn } from "@daiso-tech/core/utilities";
* import Redis from "ioredis"
* import Sqlite from "better-sqlite3";
*
* function lockAdapterFactory(database: ISqliteDatabase): AsyncFactoryFn<string, IDatabaseLockAdapter> {
* return async (prefix) => {
* const lockAdapter = new SqliteLockAdapter({
* database,
* tableName: `lock_${prefix}`
* });
* await lockAdapter.init();
* return lockAdapter;
* }
* }
*
* const database = new Sqlite("local.db");
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const lockProviderFactory = new LockProviderFactory({
* serde,
* keyPrefixer: new KeyPrefixer("lock"),
* adapters: {
* sqlite: lockAdapterFactory(database),
* memory: new MemoryLockAdapter(),
* redis: new RedisLockAdapter({
* client: new Redis("YOUR_REDIS_CONNECTION"),
* serde,
* }),
* },
* 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 which is RedisLockAdapter
* await lockProviderFactory
* .use("redis")
* .create("a")
* .acquire();
*
* // You can change the default settings of the returned Lock instance.
* await lockProviderFactory
* .setDefaultTtl(TimeSpan.fromMinutes(2))
* .use("sqlite")
* .create("a")
* .acquire();
* ```
*/
use(adapterName?: TAdapters | undefined): ILockProvider;
}