Type Alias ILockAdapter

Type declaration

• acquire:function

  • acquire(key, owner, ttl): PromiseLike<boolean>

  • The acquire method acquires a lock only if the lock is not already acquired. Returns true if not already acquired othewise false is returned.

    Parameters

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

    Returns PromiseLike<boolean>

• forceRelease:function

  • forceRelease(key): PromiseLike<void>

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

    Parameters

    • key: string

    Returns PromiseLike<void>

• getGroup:function

  • getGroup(): string

  • The getGroup method returns the group name.

    Returns string

• refresh:function

  • refresh(key, owner, ttl): PromiseLike<boolean>

  • The refresh method will upadte ttl of lock if it matches the given key and matches the given owner. Returns true if the update occured otherwise false is returned.

    Parameters

    • key: string
    • owner: string
    • ttl: TimeSpan

    Returns PromiseLike<boolean>

• release:function

  • release(key, owner): PromiseLike<boolean>

  • The release method releases a lock if the owner matches. Returns true if released otherwise false is returned.

    Parameters

    • key: string
    • owner: string

    Returns PromiseLike<boolean>

• withGroup:function

  • withGroup(group): ILockAdapter

  • The withGroup method returns a new IDatabaseLockAdapter instance that groups locks together. Only locks in the same group will be acquired and released, leaving locks outside the group unaffected.

    Parameters

    • group: string

    Returns ILockAdapter