Interface IInfo

The information about a JupyterLab application.

interface IInfo {
    availablePlugins: IPluginInfo[];
    deferred: {
        matches: string[];
        patterns: string[];
    };
    devMode: boolean;
    disabled: {
        matches: string[];
        patterns: string[];
    };
    filesCached: boolean;
    isConnected: boolean;
    mimeExtensions: IRenderMime.IExtensionModule[];
}

Properties

availablePlugins deferred devMode disabled filesCached isConnected mimeExtensions

Properties

Readonly availablePlugins

availablePlugins: IPluginInfo[]

The information about available plugins.

Readonly deferred

deferred: {
    matches: string[];
    patterns: string[];
}

The collection of deferred extension patterns and matched extensions.

Type declaration

  • matches: string[]
  • patterns: string[]

Readonly devMode

devMode: boolean

Whether the application is in dev mode.

Readonly disabled

disabled: {
    matches: string[];
    patterns: string[];
}

The collection of disabled extension patterns and matched extensions.

Type declaration

  • matches: string[]
  • patterns: string[]

Readonly filesCached

filesCached: boolean

Whether files are cached on the server.

isConnected

isConnected: boolean

Every periodic network polling should be paused while this is set to false. Extensions should use this value to decide whether to proceed with the polling. The extensions may also set this value to false if there is no need to fetch anything from the server backend basing on some conditions (e.g. when an error message dialog is displayed). At the same time, the extensions are responsible for setting this value back to true.

Readonly mimeExtensions

mimeExtensions: IRenderMime.IExtensionModule[]

The mime renderer extensions.

Settings

Member Visibility

Theme

On This Page

availablePluginsdeferreddevModedisabledfilesCachedisConnectedmimeExtensions