Class IdeConnection

constructor

• new IdeConnection(serverUrl, connectOptions?, fromJava?): IdeConnection

• creates a new instance, from which console sessions can be made. options are optional.

  Parameters

  • serverUrl: string

    The url used when connecting to the server. Read-only.

  • Optional connectOptions: ConnectOptions

    Optional Object

  • Optional fromJava: boolean

    Optional boolean

  Returns IdeConnection

  Deprecated

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_SHUTDOWN

Static Readonly HACK_CONNECTION_FAILURE

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: CustomEvent<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Listen for events on this object.

      Returns void

      Returns a cleanup function.

close

• close(): void

• closes the current connection, releasing any resources on the server or client.

  Returns void

getConsoleTypes

• getConsoleTypes(): Promise<string[]>

• Returns Promise<string[]>

getObject

• getObject(definitionObject): Promise<any>

• Parameters

  • definitionObject: VariableDescriptor

  Returns Promise<any>

getWorkerHeapInfo

• getWorkerHeapInfo(): Promise<WorkerHeapInfo>

• Returns Promise<WorkerHeapInfo>

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<CustomEvent<T>>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<CustomEvent<T>>

onLogMessage

• onLogMessage(callback): (() => void)

• Register a callback function to handle any log messages that are emitted on the server. Returns a function , which can be invoked to remove this log handler. Any log handler registered in this way will receive as many old log messages as are presently available.

  Parameters

  • callback: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: LogItem

        Returns void

  Returns (() => void)

  io.deephaven.web.shared.fu.JsRunnable

  • • (): void

    • Register a callback function to handle any log messages that are emitted on the server. Returns a function , which can be invoked to remove this log handler. Any log handler registered in this way will receive as many old log messages as are presently available.

      Returns void

      io.deephaven.web.shared.fu.JsRunnable

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: CustomEvent<T>

        Returns void

  Returns boolean

running

• running(): Promise<IdeConnection>

• Returns Promise<IdeConnection>

startSession

• startSession(type): Promise<IdeSession>

• Parameters

  • type: string

  Returns Promise<IdeSession>

subscribeToFieldUpdates

• subscribeToFieldUpdates(callback): (() => void)

• Parameters

  • callback: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: VariableChanges

        Returns void

  Returns (() => void)

  • • (): void

    • Returns void