Interface ISettings

A Jupyter server settings object. Note that all of the settings are optional when passed to [[makeSettings]]. The default settings are given in [[defaultSettings]].

interface ISettings {
    Headers: {
        prototype: Headers;
        new (init?): Headers;
    };
    Request: {
        prototype: Request;
        new (input, init?): Request;
    };
    WebSocket: {
        CLOSED: 3;
        CLOSING: 2;
        CONNECTING: 0;
        OPEN: 1;
        prototype: WebSocket;
        new (url, protocols?): WebSocket;
    };
    appUrl: string;
    appendToken: boolean;
    baseUrl: string;
    fetch: ((input, init?) => Promise<Response>);
    init: RequestInit;
    serializer: ISerializer;
    token: string;
    wsUrl: string;
}

Properties

Headers Request WebSocket appUrl appendToken baseUrl fetch init serializer token wsUrl

Properties

Readonly Headers

Headers: {
    prototype: Headers;
    new (init?): Headers;
}

The Headers object constructor.

Type declaration

Readonly Request

Request: {
    prototype: Request;
    new (input, init?): Request;
}

The Request object constructor.

Type declaration

    • new (input, init?): Request

    • Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Request

  • prototype: Request

Readonly WebSocket

WebSocket: {
    CLOSED: 3;
    CLOSING: 2;
    CONNECTING: 0;
    OPEN: 1;
    prototype: WebSocket;
    new (url, protocols?): WebSocket;
}

The WebSocket object constructor.

Type declaration

    • new (url, protocols?): WebSocket

    • Parameters

      • url: string | URL
      • Optional protocols: string | string[]

      Returns WebSocket

  • Readonly CLOSED: 3
  • Readonly CLOSING: 2
  • Readonly CONNECTING: 0
  • Readonly OPEN: 1
  • prototype: WebSocket

Readonly appUrl

appUrl: string

The app url of the JupyterLab application.

Readonly appendToken

appendToken: boolean

Whether to append a token to a Websocket url. The default is false in the browser and true in node or jest.

Readonly baseUrl

baseUrl: string

The base url of the server.

Readonly fetch

fetch: ((input, init?) => Promise<Response>)

The fetch method to use.

Type declaration

Readonly init

init: RequestInit

The default request init options.

Readonly serializer

serializer: ISerializer

Serializer used to serialize/deserialize kernel messages.

Readonly token

token: string

The authentication token for requests. Use an empty string to disable.

Readonly wsUrl

wsUrl: string

The base ws url of the server.

Settings

Member Visibility

Theme

On This Page

HeadersRequestWebSocketappUrlappendTokenbaseUrlfetchinitserializertokenwsUrl