Type Alias ILockBase

Type declaration

• acquire:function

  • acquire(): LazyPromise<boolean>

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

    Returns LazyPromise<boolean>

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

• acquireBlocking:function

  • acquireBlocking(settings?: LockAquireBlockingSettings): LazyPromise<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 LazyPromise<boolean>

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

• acquireBlockingOrFail:function

  • acquireBlockingOrFail(settings?: LockAquireBlockingSettings): LazyPromise<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 LazyPromise<void>

    Throws

    FailedAcquireLockError

• acquireOrFail:function

  • acquireOrFail(): LazyPromise<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 LazyPromise<void>

    Throws

    FailedAcquireLockError

• forceRelease:function

  • forceRelease(): LazyPromise<boolean>

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

    Returns LazyPromise<boolean>

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

• getId:function

  • getId(): string

  • The getId method returns the id of the ILock instance.

    Returns string

• getTtl:function

  • getTtl(): null | TimeSpan

  • The getTtl method returns the ttl of ILock instance.

    Returns null | TimeSpan

• refresh:function

  • refresh(ttl?: TimeSpan): LazyPromise<boolean>

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

    Parameters

    • Optionalttl: TimeSpan

    Returns LazyPromise<boolean>

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

• refreshOrFail:function

  • refreshOrFail(ttl?: TimeSpan): LazyPromise<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: TimeSpan

    Returns LazyPromise<void>

    Throws

    FailedRefreshLockError

• release:function

  • release(): LazyPromise<boolean>

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

    Returns LazyPromise<boolean>

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

• releaseOrFail:function

  • releaseOrFail(): LazyPromise<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 LazyPromise<void>

    Throws

    FailedReleaseLockError

• run:function

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

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

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns LazyPromise<Result<TValue, FailedAcquireLockError>>

• runBlocking:function

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

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

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: LockAquireBlockingSettings

    Returns LazyPromise<Result<TValue, FailedAcquireLockError>>

• runBlockingOrFail:function

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

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

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: LockAquireBlockingSettings

    Returns LazyPromise<TValue>

    Throws

    FailedAcquireLockError

• runOrFail:function

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

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

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns LazyPromise<TValue>

    Throws

    FailedAcquireLockError