ProtectedconstructorStatic ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyHACK_Closes the current connection, releasing any resources on the server or client.
Fetches the object a variable descriptor names.
the variable descriptor
a pending table if the object is a table, otherwise a promise of the object
Reads an object shared by another client to this server with the sharedTicketBytes. Until the other
client releases this object (or their session ends), the object will be available on the server.
The type of the object must be passed so that the object can be read from the server correct - the other client should provide this information.
The value provided by another client/user to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.
The type of the object, so it can be correctly read from the server.
the shared object, as a pending object that rejects with an error if it cannot be read
Load the named table, with columns and size information already fully populated.
the name of the table to fetch.
OptionalapplyPreviewColumns: boolean
false to disable previews. Defaults to true.
the table, as a pending table that rejects with an error if it cannot be loaded
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.
Merges the given tables into a single table. Assumes all tables have the same structure.
the tables to merge, which must have the same columns and be from this connection
the merged table, as a pending table
Creates a table on the server from the given column data.
the name of each column
the type of each column
the values of each column, as strings
the time zone to read date-time values in
the new table, as a pending table
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.
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.
io.deephaven.web.shared.fu.JsRunnable
Promise that resolves when this worker instance can be connected to, or rejects if it can't be used.
A promise that resolves with this instance.
Makes an object available to another user or another client on this same server which knows the value of
the sharedTicketBytes. Use that sharedTicketBytes value like a one-time use password - any other
client which knows this value can read the same object.
Shared objects will remain available using the sharedTicketBytes until the client that first shared them
releases/closes their copy of the object. Whatever side-channel is used to share the bytes, be sure to wait until
the remote end has signaled that it has successfully fetched the object before releasing it from this client. A
pending table that nothing awaits is released once its result arrives and the share has been made, so keep it by
awaiting it, or share the table that awaiting gives.
Be sure to use an unpredictable value for the shared ticket bytes, like a UUID or other large, random value to prevent access by unauthorized clients.
The object to share with another client/user.
The value which another client/user must know to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.
A promise that will resolve to the value passed as sharedTicketBytes when the object is ready to
be read by another client, or will reject if an error occurs.
Presently, this is the entrypoint into the Deephaven JS API. By creating an instance of this with the server URL and some options, JS applications can run code on the server and interact with available exportable objects.