Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Connection

Hierarchy

  • EventEmitter
    • Connection

Index

Constructors

constructor

Properties

connected

connected: boolean

Private eventListeners

eventListeners: EventListeners

options

redis

redis: Redis | Cluster

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: string | symbol, listener: (...args: any[]) => void): Connection
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

connect

  • connect(): Promise<void>

emit

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

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

    Returns boolean

end

  • end(): void

eventNames

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

getKeys

  • getKeys(match: string, count?: number, keysAry?: any[], cursor?: number): any
  • Parameters

    • match: string
    • count: number = null
    • keysAry: any[] = []
    • cursor: number = 0

    Returns any

getMaxListeners

  • getMaxListeners(): number
  • Returns number

key

  • key(arg: any, arg2?: any, arg3?: any, arg4?: any): string
  • Parameters

    • arg: any
    • Optional arg2: any
    • Optional arg3: any
    • Optional arg4: any

    Returns string

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

loadLua

  • loadLua(): void

off

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

on

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

rawListeners

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

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Connection
  • Parameters

    • Optional event: string | symbol

    Returns Connection

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Connection

setMaxListeners

  • Parameters

    • n: number

    Returns Connection

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc