Class JDEvent

Readonly eventStats

newListenerStats

Readonly nodeId

Readonly service

changeId

• get changeId(): number

• Gets a counter for the CHANGE event.

  Returns number

friendlyName

• get friendlyName(): string

• Gets the event friendly name.

  Returns string

id

• get id(): string

• Gets the node identifier in the JDOM tree

  Returns string

name

• get name(): string

• Gets the event name, if specified.

  Returns string

nodeData

• get nodeData(): Record<string, unknown>

• Gets a databag to store custom information

  Returns Record<string, unknown>

notImplemented

• get notImplemented(): boolean

• Indicates if the member is not implemented on the server side

  Returns boolean

parent

• get parent(): JDNode

• Gets the parent service client instance.

  Returns JDNode

qualifiedName

• get qualifiedName(): string

• Gets the qualitified event name, if specified.

  Returns string

emit

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

• Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

  Parameters

  • eventName: string

  • Rest ...args: unknown[]

  Returns boolean

emitPropagated

• emitPropagated(event, arg?): void

• Emit event in current node and parent nodes

  Parameters

  • event: string

    event to emit

  • Optional arg: any

    event arguments

  Returns void

eventNames

• eventNames(): string[]

• Returns an array listing the events for which the emitter has registered listeners.

  Returns string[]

listenerCount

• listenerCount(eventName): number

• Gets the number of listeners for a given event

  Parameters

  • eventName: string

    name of the event

  Returns number

  number of registered handlers

listenerStackTraces

• listenerStackTraces(eventName): string[]

• Gets the list stack trace where an event was registered. Only enabled if Flags.debug is true.

  Parameters

  • eventName: string

    name of the event

  Returns string[]

  stack traces where a listener was added

observe

• observe<T>(eventName): Observable<T>

• Creates an observable from the given event

  Type Parameters

  • T

  Parameters

  • eventName: string | string[]

  Returns Observable<T>

off

• off(eventName, handler): JDEvent

• Unregisters a handler for one or more events

  Parameters

  • eventName: string | string[]

    name or names of the events to subscribe

  • handler: EventHandler

    handler to unregister

  Returns JDEvent

  current object instance

on

• on(eventName, handler): JDEvent

• Registers a handler for one or more events

  Parameters

  • eventName: string | string[]

    name or names of the events to subscribe

  • handler: EventHandler

    handler to register

  Returns JDEvent

  current object instance

once

• once(eventName, handler): JDEvent

• Registers a handler for one or more events to run only once.

  Parameters

  • eventName: string | string[]

    name or names of the events to subscribe

  • handler: EventHandler

    handler to execute

  Returns JDEvent

  current object instance

subscribe

• subscribe<T>(eventName, next): (() => void)

• Subscribes to an event and returns the unsubscription handler

  Type Parameters

  • T

  Parameters

  • eventName: string | string[]

  • next: ((value) => void)

    • • (value): void

      • Parameters

        • value: T

        Returns void

  Returns (() => void)

  • • (): void

    • Subscribes to an event and returns the unsubscription handler

      Returns void

      Category

      JDOM

awaitOnce

• awaitOnce(eventName, token?): Promise<void>

• Awaits an event with a timeout. Throws JacdacError with timeout if operation does not return.

  Parameters

  • eventName: string | string[]

  • Optional token: JDCancellationToken

  Returns Promise<void>

Readonly code

specification

• get specification(): PacketInfo

• Gets the event specification if known.

  Returns PacketInfo