Type Alias ISharedLockAdapter

Type declaration

• acquireReader:function

  • acquireReader(settings: SharedLockAcquireSettings): Promise<boolean>

  • The acquireReader method acquires a slot only if the slot limit is not reached.

    Parameters

    • settings: SharedLockAcquireSettings

    Returns Promise<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireWriter:function

  • acquireWriter(
        key: string,
        lockId: string,
        ttl: null | TimeSpan,
    ): Promise<boolean>

  • The acquireWriter method acquires a lock only if expired.

    Parameters

    • key: string
    • lockId: string
    • ttl: null | TimeSpan

    Returns Promise<boolean>

    Returns true if expired otherwise false is returned.

• forceRelease:function

  • forceRelease(key: string): Promise<boolean>

  • Parameters

    • key: string

    Returns Promise<boolean>

• forceReleaseAllReaders:function

  • forceReleaseAllReaders(key: string): Promise<boolean>

  • The forceReleaseAllReaders method releases all slots related to the key.

    Parameters

    • key: string

    Returns Promise<boolean>

• forceReleaseWriter:function

  • forceReleaseWriter(key: string): Promise<boolean>

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

    Parameters

    • key: string

    Returns Promise<boolean>

    Returns true if the lock exists or false if the lock is expired.

• getState:function

  • getState(key: string): Promise<null | ISharedLockAdapterState>

  • Parameters

    • key: string

    Returns Promise<null | ISharedLockAdapterState>

• refreshReader:function

  • refreshReader(key: string, slotId: string, ttl: TimeSpan): Promise<boolean>

  • The refreshReader method expiration of slot if not already expired.

    Parameters

    • key: string
    • slotId: string
    • ttl: TimeSpan

    Returns Promise<boolean>

    Returns true if the slot is refreshed* otherwise false is returned.

• refreshWriter:function

  • refreshWriter(key: string, lockId: string, ttl: TimeSpan): Promise<boolean>

  • The refreshWriter method will upadte ttl of lock if it matches the owner and is expireable.

    Parameters

    • key: string
    • lockId: string
    • ttl: TimeSpan

    Returns Promise<boolean>

    Returns false if the lock is unexpireable, the is expired, does not match the owner otherwise true is returned.

• releaseReader:function

  • releaseReader(key: string, slotId: string): Promise<boolean>

  • The releaseReader method releases given slot related to the key.

    Parameters

    • key: string
    • slotId: string

    Returns Promise<boolean>

    Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.

• releaseWriter:function

  • releaseWriter(key: string, lockId: string): Promise<boolean>

  • The releaseWriter method releases a lock if the owner matches.

    Parameters

    • key: string
    • lockId: string

    Returns Promise<boolean>

    Returns true if released otherwise false is returned.