@deephaven/jsapi-types
    Preparing search index...

    Class ConnectOptions

    Addition optional configuration that can be passed to the CoreClient constructor.

    Index
    debug?: boolean

    Set to true to enable debug logging. At this time, only enables logging for gRPC calls.

    headers?: { [key: string]: string }

    Optional map of http header names and values to send to the server with each request.

    transportFactory?: GrpcTransportFactory

    The transport factory to use for creating gRPC streams. If specified, the JS API will ignore ConnectOptions.useWebsockets and its own internal logic for determining the appropriate transport to use.

    Defaults to null, indicating that the JS API should determine the appropriate transport to use. If useWebsockets is set to true, the JS API will use websockets, otherwise if the server url begins with https, it will use fetch, otherwise it will use websockets.

    useWebsockets?: boolean

    Set this to true to force the use of websockets when connecting to the Deephaven instance over https. Ignored if ConnectOptions.transportFactory is set.

    An http server URL always uses websockets, because fetch can't be used over http. For an https URL, any value other than true, including the default of null, uses fetch.