OptionalconnectOptions: ConnectOptionsStatic ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static Optional ReadonlyFEATURESA collection of feature flags that the JS API advertises. All must be nullable booleans, and if listed, the value is true.
Marked as nullable as past releases will not have this property, be sure to test for null if an older release might be in use.
Static ReadonlyLOGIN_Password login type.
When used as credentials.type for CoreClient.login(), the credentials must include a username and a password.
Static ReadonlyLOGIN_Password login type.
When used as credentials.type for CoreClient.login(), the credentials must include a username and a password.
Disconnects and releases resources associated with this client.
Returns a promise that resolves to the underlying IdeConnection.
Fetches authentication configuration values.
This method is intended to be used before a session is established.
a promise of key/value pairs, returned as a two-element string array per entry
Fetches server configuration values for the current connection.
a promise of configuration entries as an array of [key, value] string pairs
Returns the server URL associated with this client.
Returns a storage service associated with this client's connection.
Checks whether any event listeners are registered for the given event name.
The event name.
true if there is at least one listener registered for name; false otherwise.
Logs in using the provided credentials.
the login credentials
a promise which resolves once the client has connected using the provided credentials
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.
The type of the event detail.
The event name.
OptionaltimeoutInMillis: number
Optional timeout in milliseconds.
A promise that resolves with the next matching event.
Resolves when the client is connected.
OptionaltimeoutInMillis: number
ignored, only exists for legacy callers
a promise that resolves when connection is established, or rejects if connection fails
Indicates whether this client instance is still usable.
a promise which resolves to this when the client is usable
A client for connecting to a Deephaven server from the Deephaven JS API.
This type manages connection lifecycle and authentication state, and provides helpers to fetch server and authentication-related configuration.