Interface IOptions

The options used to create a service manager.

interface IOptions {
    builder: Builder.IManager;
    contents: Contents.IManager;
    defaultDrive: IDrive;
    events: Event.IManager;
    kernels: Kernel.IManager;
    kernelspecs: KernelSpec.IManager;
    nbconvert: NbConvert.IManager;
    ready: Promise<void>;
    serverSettings: ServerConnection.ISettings;
    sessions: Session.IManager;
    settings: Setting.IManager;
    standby: Standby | (() => boolean | Standby);
    terminals: Terminal.IManager;
    user: User.IManager;
    workspaces: Workspace.IManager;
}

Hierarchy

  • IManagers
    • IOptions

Properties

builder contents defaultDrive events kernels kernelspecs nbconvert ready serverSettings sessions settings standby terminals user workspaces

Properties

Readonly builder

builder: Builder.IManager

The builder for the manager.

Deprecated

will be removed in JupyterLab v5

Readonly contents

contents: Contents.IManager

The contents manager for the manager.

Readonly defaultDrive

defaultDrive: IDrive

The default drive for the contents manager.

Readonly events

events: Event.IManager

The events service manager.

Readonly kernels

kernels: Kernel.IManager

The kernel manager of the manager.

Readonly kernelspecs

kernelspecs: KernelSpec.IManager

The kernelspec manager for the manager.

Readonly nbconvert

nbconvert: NbConvert.IManager

The nbconvert manager for the manager.

Readonly ready

ready: Promise<void>

A promise that fulfills when the manager is initially ready.

Readonly serverSettings

serverSettings: ServerConnection.ISettings

The server settings of the manager.

Readonly sessions

sessions: Session.IManager

The session manager for the manager.

Readonly settings

settings: Setting.IManager

The setting manager for the manager.

standby

standby: Standby | (() => boolean | Standby)

When the manager stops polling the API. Defaults to when-hidden.

Type declaration

    • (): boolean | Standby

    • Returns boolean | Standby

Readonly terminals

terminals: Terminal.IManager

The terminals manager for the manager.

Readonly user

user: User.IManager

The user manager for the manager.

Readonly workspaces

workspaces: Workspace.IManager

The workspace manager for the manager.

Settings

Member Visibility

Theme

On This Page

buildercontentsdefaultDriveeventskernelskernelspecsnbconvertreadyserverSettingssessionssettingsstandbyterminalsuserworkspaces