Type Alias ILockBase

Type declaration

• acquire:function

  • acquire(): Task<boolean>

  • The acquire method acquires a lock only if the key is not already acquired by different owner.

    Returns Task<boolean>

    Returns true if the lock is not already acquired otherwise false is returned.

• acquireBlocking:function

  • acquireBlocking(settings?: LockAquireBlockingSettings): Task<boolean>

  • The acquireBlocking method acquires a lock only if the key is not already acquired by different owner. If the lock is not acquired, it retries every settings.interval until settings.time is reached.

    Parameters

    • Optionalsettings: LockAquireBlockingSettings

    Returns Task<boolean>

    Returns true if the lock is not already acquired otherwise false is returned.

• acquireBlockingOrFail:function

  • acquireBlockingOrFail(settings?: LockAquireBlockingSettings): Task<void>

  • The acquireBlockingOrFail method acquires a lock only if the key is not already acquired by different owner. If the lock is not acquired, it retries every settings.interval until settings.time is reached. Throws an error if the lock is already acquired by different owner.

    Parameters

    • Optionalsettings: LockAquireBlockingSettings

    Returns Task<void>

    Throws

    FailedAcquireLockError

• acquireOrFail:function

  • acquireOrFail(): Task<void>

  • The acquireOrFail method acquires a lock only if the key is not already acquired by different owner. Throws an error if the lock is already acquired by different owner.

    Returns Task<void>

    Throws

    FailedAcquireLockError

• forceRelease:function

  • forceRelease(): Task<boolean>

  • The forceRelease method releases a lock regardless of the owner.

    Returns Task<boolean>

    Returns true if the lock exists or false if the lock doesnt exists.

• refresh:function

  • refresh(ttl?: ITimeSpan): Task<boolean>

  • The refresh method updates the ttl of the lock if expireable and owned by the same owner.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Task<boolean>

    Returns true if the lock is refreshed otherwise false is returned.

• refreshOrFail:function

  • refreshOrFail(ttl?: ITimeSpan): Task<void>

  • The refreshOrFail method updates the ttl of the lock if expireable and owned by the same owner. Throws an error if the lock is not owned by same owner. Throws an error if the key is unexpirable.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Task<void>

    Throws

    FailedRefreshLockError

• release:function

  • release(): Task<boolean>

  • The release method releases a lock if owned by the same owner.

    Returns Task<boolean>

    Returns true if the lock is released otherwise false is returned.

• releaseOrFail:function

  • releaseOrFail(): Task<void>

  • The releaseOrFail method releases a lock if owned by the same owner. Throws an error if the lock is not owned by same owner.

    Returns Task<void>

    Throws

    FailedReleaseLockError

• run:function

  • run<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
    ): Task<Result<TValue, FailedAcquireLockError>>

  • The run method wraps an Invokable or Task with the acquire and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns Task<Result<TValue, FailedAcquireLockError>>

• runBlocking:function

  • runBlocking<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: LockAquireBlockingSettings,
    ): Task<Result<TValue, FailedAcquireLockError>>

  • The runBlocking method wraps an Invokable or Task with the acquireBlocking and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: LockAquireBlockingSettings

    Returns Task<Result<TValue, FailedAcquireLockError>>

• runBlockingOrFail:function

  • runBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: LockAquireBlockingSettings,
    ): Task<TValue>

  • The runBlockingOrFail method wraps an Invokable or Task with the acquireBlockingOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: LockAquireBlockingSettings

    Returns Task<TValue>

    Throws

    FailedAcquireLockError

• runOrFail:function

  • runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>

  • The runOrFail method wraps an Invokable or Task with the acquireOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns Task<TValue>

    Throws

    FailedAcquireLockError