Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExpiringLock

Interface for a lock that expires after a certain period of inactivity. Activity can be signaled by calling renew, which resets the expiration timeout. When the lock has expired, an expired event is emitted and the lock is released.

Hierarchy

  • Lock
  • EventEmitter
    • ExpiringLock

Index

Properties

Methods

Properties

release

release: () => Promise<void>

Release this lock.

returns

A promise resolving when the release is finished.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

renew

renew: () => void

Reset the lock expiration timeout.

Type declaration

    • (): void

    • Returns void

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

on

  • on(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

once

  • once(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns ExpiringLock

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ExpiringLock

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ExpiringLock

setMaxListeners

  • Parameters

    • n: number

    Returns ExpiringLock