Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message<REQ, RES>

Type parameters

Hierarchy

  • AbstractMessage<REQ, RES>
    • Message

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected active

active: boolean = true

Protected detectTargets

detectTargets: boolean

Detect targets

Private factory

factory: AbstractExchange<REQ, RES>

Protected logger

logger: ILoggerApi

Protected options

options: IMessageOptions

Protected Readonly reqClass

reqClass: ClassType<REQ>

Protected request

request: REQ

Protected Readonly resClass

resClass: ClassType<RES>

Protected responses

responses: RES[] = []

Protected results

results: any

Protected start

start: Date

Protected stop

stop: Date

Protected system

system: System

Protected targetIds

targetIds: string[]

Protected timeout

timeout: number = 5000

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): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

beforeSend

  • beforeSend(req: REQ): Promise<void>

doPostProcess

  • doPostProcess(responses: RES[], err?: Error): any

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getLocalNodeId

  • getLocalNodeId(): string

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getReqClass

  • getReqClass(): ClassType<REQ>

getResClass

  • getResClass(): ClassType<RES>

getSystem

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): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

on

  • on(event: string | symbol, listener: (...args: any[]) => void): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

onResults

  • onResults(res: RES): void

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

postProcess

  • postProcess(err?: Error): Promise<void>

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

ready

  • ready(): Promise<unknown>

removeAllListeners

  • removeAllListeners(event?: string | symbol): Message<REQ, RES>

  • Parameters

    • Optional event: string | symbol

    Returns Message<REQ, RES>

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Message<REQ, RES>

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Message<REQ, RES>

requestCheck

  • requestCheck(res: RES): boolean

  • Overrideable method to additionaly check if response is valid.

    If false the response will be ignored in onResults.

    Parameters

    • res: RES

    Returns boolean

send

  • send(req: REQ): Promise<any[]>

setMaxListeners

  • setMaxListeners(n: number): Message<REQ, RES>

  • Parameters

    • n: number

    Returns Message<REQ, RES>

target

  • target(nodeId: string): Message<REQ, RES>

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

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, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

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

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc