Interface HasEventHandling

Base class providing an event listener API for Deephaven JS client objects.

Hierarchy

HasEventHandling

Implemented by

Index

Methods

addEventListener hasListeners nextEvent removeEventListener

Methods

addEventListener

addEventListener<T>(name, callback): (() => void)
Listen for events on this object.
Type Parameters
- T
  
  The type of the data that the event will provide.
Parameters
- name: string
  
  The name of the event to listen for.
- callback: ((e) => void)
  
  A function to call when the event occurs.
  - - (e): void
    - Parameters
      
      e: Event<T>
      
      Returns void
Returns (() => void)
Returns a cleanup function.
- - (): void
  - Listen for events on this object.
    
    Returns void
    Returns a cleanup function.

hasListeners

hasListeners(name): boolean
Checks whether any event listeners are registered for the given event name.
Parameters
- name: string
  
  The event name.
Returns boolean
true if there is at least one listener registered for name; false otherwise.

nextEvent

nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>
Returns a promise that resolves the next time the named event occurs, with the value of the event's detail. If a timeout is specified and occurs before the event takes place, the promise will reject, otherwise waits indefinitely.
Type Parameters
- T
  
  The type of the event detail.
Parameters
- eventName: string
  
  The event name.
- Optional timeoutInMillis: number
  
  Optional timeout in milliseconds.
Returns Promise<Event<T>>
A promise that resolves with the next matching event.

removeEventListener

removeEventListener<T>(name, callback): boolean
Removes an event listener added to this table.
Type Parameters
- T
Parameters
- name: string
- callback: ((e) => void)
  - - (e): void
    - Parameters
      
      e: Event<T>
      
      Returns void
Returns boolean

Interface HasEventHandling

Hierarchy

Implemented by

Index

Methods

Methods

addEventListener

Type Parameters

T

Parameters

name: string

callback: ((e) => void)

Parameters

e: Event<T>

Returns void

Returns (() => void)

Returns void

hasListeners

Parameters

name: string

Returns boolean

nextEvent

Type Parameters

T

Parameters

eventName: string

Optional timeoutInMillis: number

Returns Promise<Event<T>>

removeEventListener

Type Parameters

T

Parameters

name: string

callback: ((e) => void)

Parameters

e: Event<T>

Returns void

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Optional` timeoutInMillis: number