Class TimedEmitter

Setup a blocking wait. Used in B(locking)* commands, such as [[BRPOP]][[BRPopCommand]].

Unlike redis, which allows an infinite wait when timoutSeconds is ZERO, unit-redis-ness allows only for a maximum of about 24.85 days

Param: timeoutSeconds

Number of seconds to wait

Param: keyEventNames

Array of events to wait for

Param: emitter

The serverContext is the emitter

Returns

TimedEmitter EventEmitter

Events: timout

Hierarchy

Constructors

constructor

Properties

callback keyEventNames logger timeoutSeconds captureRejectionSymbol captureRejections defaultMaxListeners errorMonitor

Methods

addListener emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners listenerCount on once

Constructors

constructor

Properties

callback

callback: any = null

Private keyEventNames

keyEventNames: string[]

Private logger

logger: Logger = ...

Private timeoutSeconds

timeoutSeconds: number

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

emit

  • emit(event, ...args): boolean

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

on

  • on(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

once

  • once(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

prependListener

  • prependListener(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

prependOnceListener

  • prependOnceListener(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

rawListeners

  • rawListeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

removeListener

  • removeListener(event, listener): TimedEmitter

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TimedEmitter

setMaxListeners

Static listenerCount

  • listenerCount(emitter, event): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

    Deprecated

    since v4.0.0

Static on

Static once

  • once(emitter, event): Promise<any[]>

  • Parameters

    Returns Promise<any[]>

  • once(emitter, event): Promise<any[]>

  • Parameters

    Returns Promise<any[]>

Settings

Member Visibility

Theme

On This Page