Class LockProvider

LockProvider class can be derived from any ILockAdapter or IDatabaseLockAdapter.

Note the 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 IFlexibleSerde or indirectly through components that rely on IFlexibleSerde internally.

IMPORT_PATH: "@daiso-tech/core/lock/implementations/derivables"

Implements

Constructors

constructor

Methods

addListener addListenerMany asPromise create getGroup listenOnce removeListener removeListenerMany subscribe subscribeMany withGroup

Constructors

constructor

  • new LockProvider(settings): LockProvider

  • Parameters

    Returns LockProvider

    Example

    import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

Methods

addListener

  • addListener<TEventClass>(event, listener): LazyPromise<void>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<void>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    await lockProvider.addListener(KeyAcquiredLockEvent, listener);
    await lockProvider.removeListener(KeyAcquiredLockEvent, listener);
    await lockProvider.create("a").acquire();

addListenerMany

  • addListenerMany<TEventClass>(events, listener): LazyPromise<void>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<void>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    await lockProvider.addListenerMany([KeyAcquiredLockEvent], listener);
    await lockProvider.removeListenerMany([KeyAcquiredLockEvent], listener);
    await lockProvider.create("a").acquire();

asPromise

create

  • create(key, settings?): ILock
  • import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
    import { TimeSpan } from "@daiso-tech/core/utilities";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    // You can use the lock
    const lockA = lockProvider.create("a");

    // You can provide ttl
    const lockB = lockProvider.create("b", {
      ttl: TimeSpan.fromMinutes(2),
    });

    // You can provide a custom owner. By default the owner will be unique random value.
    const lockC = lockProvider.create("b", {
      owner: "user-1"
    });

    Parameters

    Returns ILock

getGroup

  • getGroup(): string

  • Returns string

    Example

    import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    // Will print "@global"
    console.log(lockProvider.getGroup());

listenOnce

  • listenOnce<TEventClass>(event, listener): LazyPromise<void>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<void>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    await lockProvider.listenOnce(KeyAcquiredLockEvent, listener);
    await lockProvider.create("a").acquire();

removeListener

  • removeListener<TEventClass>(event, listener): LazyPromise<void>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<void>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    await lockProvider.addListener(KeyAcquiredLockEvent, listener);
    await lockProvider.removeListener(KeyAcquiredLockEvent, listener);
    await lockProvider.create("a").acquire();

removeListenerMany

  • removeListenerMany<TEventClass>(events, listener): LazyPromise<void>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<void>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    await lockProvider.addListenerMany(KeyAcquiredLockEvent, listener);
    await lockProvider.removeListenerMany([KeyAcquiredLockEvent], listener);
    await lockProvider.create("a").acquire();

subscribe

  • subscribe<TEventClass>(event, listener): LazyPromise<Unsubscribe>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<Unsubscribe>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    const unsubscribe = await lockProvider.subscribe(KeyAcquiredLockEvent, listener);
    await lockProvider.create("a").acquire();
    await unsubscribe();

subscribeMany

  • subscribeMany<TEventClass>(events, listener): LazyPromise<Unsubscribe>

  • You can listen to different events of all locks created by LockProvider class instance.

    Refer to LockEvents, to se all events dispatched by LockProvider class instance. Refer to IEventListenable for details on how the method works.

    Type Parameters

    Parameters

    Returns LazyPromise<Unsubscribe>

    Example

    import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import type { Invokable} from "@daiso-tech/core/event-bus/contracts";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    const listener: Invokable<LockEvents> = event => {
      console.log(event);
    }
    const unsubscribe = await lockProvider.subscribeMany([KeyAcquiredLockEvent], listener);
    await lockProvider.create("a").acquire();
    await unsubscribe();

withGroup

  • withGroup(group): ILockProvider

  • Parameters

    Returns ILockProvider

    Example

    import type { IGroupableLockProvider, ILockProvider } from "@daiso-tech/core/lock/contracts";
    import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
    import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
    import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
    import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
    import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";

    const eventBus = new EventBus({
      adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
    });
    const serde = new Serde(SuperJsonSerdeAdapter);
    const lockProvider: IGroupableLockProvider = new LockProvider({
      serde,
      adapter: new MemoryLockAdapter({
        rootGroup: "@global"
      }),
      eventBus,
    });

    // Will print "@global"
    console.log(lockProvider.getGroup());

    const groupedLockProvider: ILockProvider = lockProvider.withGroup("company-1");

    // Will print "@global/company-1"
    console.log(groupedLockProvider.getGroup());

Settings

Member Visibility

On This Page

Constructors
Methods