• Public
  • Public/Protected
  • All

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


  • ISettings



Readonly Headers

Headers: { prototype: Headers }

The Headers object constructor.

Type declaration

  • prototype: Headers

Readonly Request

Request: { prototype: Request }

The Request object constructor.

Type declaration

  • prototype: Request

Readonly WebSocket

WebSocket: { CLOSED: number; CLOSING: number; CONNECTING: number; OPEN: number; prototype: WebSocket }

The WebSocket object constructor.

Type declaration

  • Readonly CLOSED: number
  • Readonly CLOSING: number
  • Readonly CONNECTING: number
  • Readonly OPEN: number
  • 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: RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration

    • (input: RequestInfo, init?: RequestInit): Promise<Response>
    • The fetch method to use.


      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

Readonly init

init: RequestInit

The default request init options.

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.

Generated using TypeDoc