Class SimpleLockProvider

Offers locking a mechanism to prevent race conditions.

Implements

Constructors

constructor

Methods

acquire

Constructors

constructor

Methods

acquire

  • acquire<T>(
        key: string,
        callback: () => Promise<T>,
        options: { maxOccupationTime: number; timeout: number },
    ): Promise<T>

    Type Parameters

    • T

    Parameters

    • key: string

      the key of the resource to lock

    • callback: () => Promise<T>

      the code which should run once the lock was acquired

    • options: { maxOccupationTime: number; timeout: number }

    Returns Promise<T>

    Throws

    'timeout' or 'occupation-time-exceed' errors

Settings

Member Visibility

On This Page

Constructors
Methods