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 {
    appendToken: boolean;
    appUrl: string;
    baseUrl: string;
    fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
    Headers: { prototype: Headers; new (init?: HeadersInit): Headers };
    init: RequestInit;
    Request: {
        prototype: Request;
        new (input: RequestInfo | URL, init?: RequestInit): Request;
    };
    serializer: ISerializer;
    token: string;
    WebSocket: {
        CLOSED: 3;
        CLOSING: 2;
        CONNECTING: 0;
        OPEN: 1;
        prototype: WebSocket;
        new (url: string | URL, protocols?: string | string[]): WebSocket;
    };
    wsUrl: string;
}

Properties

appendToken appUrl baseUrl fetch Headers init Request serializer token WebSocket wsUrl

Properties

ReadonlyappendToken

appendToken: boolean

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

ReadonlyappUrl

appUrl: string

The app url of the JupyterLab application.

ReadonlybaseUrl

baseUrl: string

The base url of the server.

Readonlyfetch

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

The fetch method to use.

ReadonlyHeaders

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

The Headers object constructor.

Readonlyinit

init: RequestInit

The default request init options.

ReadonlyRequest

Request: {
    prototype: Request;
    new (input: RequestInfo | URL, init?: RequestInit): Request;
}

The Request object constructor.

Readonlyserializer

serializer: ISerializer

Serializer used to serialize/deserialize kernel messages.

Readonlytoken

token: string

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

ReadonlyWebSocket

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

The WebSocket object constructor.

ReadonlywsUrl

wsUrl: string

The base ws url of the server.

Settings

Member Visibility

On This Page

Properties