Class: JupyterLiteServer

server.JupyterLiteServer

Server is the main application class. It is instantiated once and shared.

Hierarchy

  • Application<never>

    JupyterLiteServer

Constructors

constructor

new JupyterLiteServer(options)

Construct a new JupyterLite object.

Parameters

Name

Type

Description

options

IOptions<never>

The instantiation options for a JupyterLiteServer application.

Overrides

Application<never&gt;.constructor

Defined in

packages/server/lib/app.d.ts:7

Properties

_serviceManager

Private _serviceManager: any

Defined in

packages/server/lib/app.d.ts:64


commands

Readonly commands: CommandRegistry

The application command registry.

Inherited from

Application.commands

Defined in

node_modules/@lumino/application/types/index.d.ts:104


contextMenu

Readonly contextMenu: ContextMenu

The application context menu.

Inherited from

Application.contextMenu

Defined in

node_modules/@lumino/application/types/index.d.ts:108


name

Readonly name: "JupyterLite Server"

The name of the application.

Defined in

packages/server/lib/app.d.ts:17


namespace

Readonly namespace: "JupyterLite Server"

A namespace/prefix plugins may use to denote their provenance.

Defined in

packages/server/lib/app.d.ts:21


shell

Readonly shell: never

The application shell widget.

Notes

The shell widget is the root “container” widget for the entire application. It will typically expose an API which allows the application plugins to insert content in a variety of places.

Inherited from

Application.shell

Defined in

node_modules/@lumino/application/types/index.d.ts:117


started

Readonly started: Promise<void>

A promise which resolves after the application has started.

Notes

This promise will resolve after the start() method is called, when all the bootstrapping and shell mounting work is complete.

Inherited from

Application.started

Defined in

node_modules/@lumino/application/types/index.d.ts:125


version

Readonly version: "unknown"

The version of the application.

Defined in

packages/server/lib/app.d.ts:25

Accessors

serviceManager

get serviceManager(): null | LiteServiceManager

Get the underlying lite service manager for this app.

Returns

null | LiteServiceManager

Defined in

packages/server/lib/app.d.ts:29

Methods

activatePlugin

activatePlugin(id): Promise<void>

Activate the plugin with the given id.

Parameters

Name

Type

Description

id

string

The ID of the plugin of interest.

Returns

Promise<void>

A promise which resolves when the plugin is activated or rejects with an error if it cannot be activated.

Inherited from

Application.activatePlugin

Defined in

node_modules/@lumino/application/types/index.d.ts:170


addEventListeners

Protected addEventListeners(): void

Add the application event listeners.

Notes

The default implementation of this method adds listeners for 'keydown' and 'resize' events.

A subclass may reimplement this method as needed.

Returns

void

Inherited from

Application.addEventListeners

Defined in

node_modules/@lumino/application/types/index.d.ts:264


attachShell

Protected attachShell(id): void

Attach the application shell to the DOM.

Parameters

Name

Type

Description

id

string

The id of the host node for the shell, or ''. #### Notes For this server application there is no shell to attach

Returns

void

Overrides

Application.attachShell

Defined in

packages/server/lib/app.d.ts:38


evtContextMenu

Protected evtContextMenu(event): void

A method invoked on a document 'contextmenu' event.

Notes

The default implementation of this method opens the application contextMenu at the current mouse position.

If the application context menu has no matching content or if the shift key is pressed, the default browser context menu will be opened instead.

A subclass may reimplement this method as needed.

Parameters

Name

Type

event

MouseEvent

Returns

void

Inherited from

Application.evtContextMenu

Defined in

node_modules/@lumino/application/types/index.d.ts:288


evtKeydown

Protected evtKeydown(event): void

A method invoked on a document 'keydown' event.

Notes

The default implementation of this method invokes the key down processing method of the application command registry.

A subclass may reimplement this method as needed.

Parameters

Name

Type

event

KeyboardEvent

Returns

void

Inherited from

Application.evtKeydown

Defined in

node_modules/@lumino/application/types/index.d.ts:274


evtResize

Protected evtResize(event): void

A method invoked on a window 'resize' event.

Notes

For this server application there is no shell to update

Parameters

Name

Type

event

Event

Returns

void

Overrides

Application.evtResize

Defined in

packages/server/lib/app.d.ts:45


handleEvent

handleEvent(event): void

Handle the DOM events for the application.

Parameters

Name

Type

Description

event

Event

The DOM event sent to the application. #### Notes This method implements the DOM EventListener interface and is called in response to events registered for the application. It should not be called directly by user code.

Returns

void

Inherited from

Application.handleEvent

Defined in

node_modules/@lumino/application/types/index.d.ts:243


hasPlugin

hasPlugin(id): boolean

Test whether a plugin is registered with the application.

Parameters

Name

Type

Description

id

string

The id of the plugin of interest.

Returns

boolean

true if the plugin is registered, false otherwise.

Inherited from

Application.hasPlugin

Defined in

node_modules/@lumino/application/types/index.d.ts:133


listPlugins

listPlugins(): string[]

List the IDs of the plugins registered with the application.

Returns

string[]

A new array of the registered plugin IDs.

Inherited from

Application.listPlugins

Defined in

node_modules/@lumino/application/types/index.d.ts:139


registerPlugin

registerPlugin(plugin): void

Register a plugin with the application.

Parameters

Name

Type

Description

plugin

IPlugin<JupyterLiteServer, any>

The plugin to register. #### Notes An error will be thrown if a plugin with the same id is already registered, or if the plugin has a circular dependency. If the plugin provides a service which has already been provided by another plugin, the new service will override the old service.

Returns

void

Inherited from

Application.registerPlugin

Defined in

node_modules/@lumino/application/types/index.d.ts:152


registerPluginModule

registerPluginModule(mod): void

Register plugins from a plugin module.

Parameters

Name

Type

Description

mod

IPluginModule

The plugin module to register.

Returns

void

Defined in

packages/server/lib/app.d.ts:51


registerPluginModules

registerPluginModules(mods): void

Register the plugins from multiple plugin modules.

Parameters

Name

Type

Description

mods

IPluginModule[]

The plugin modules to register.

Returns

void

Defined in

packages/server/lib/app.d.ts:57


registerPlugins

registerPlugins(plugins): void

Register multiple plugins with the application.

Parameters

Name

Type

Description

plugins

IPlugin<JupyterLiteServer, any>[]

The plugins to register. #### Notes This calls registerPlugin() for each of the given plugins.

Returns

void

Inherited from

Application.registerPlugins

Defined in

node_modules/@lumino/application/types/index.d.ts:161


registerServiceManager

registerServiceManager(serviceManager): void

Register the underlying lite service manager for this app.

Parameters

Name

Type

Description

serviceManager

LiteServiceManager

The Service Manager for the app.

Returns

void

Defined in

packages/server/lib/app.d.ts:63


resolveOptionalService

resolveOptionalService<U>(token): Promise<null | U>

Resolve an optional service of a given type.

Type parameters

Name

U

Parameters

Name

Type

Description

token

Token<U>

The token for the service type of interest.

Returns

Promise<null | U>

A promise which resolves to an instance of the requested service, or null if it cannot be resolved.

Notes

Services are singletons. The same instance will be returned each time a given service token is resolved.

If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.

User code will not typically call this method directly. Instead, the optional services for the user’s plugins will be resolved automatically when the plugin is activated.

Inherited from

Application.resolveOptionalService

Defined in

node_modules/@lumino/application/types/index.d.ts:210


resolveRequiredService

resolveRequiredService<U>(token): Promise<U>

Resolve a required service of a given type.

Type parameters

Name

U

Parameters

Name

Type

Description

token

Token<U>

The token for the service type of interest.

Returns

Promise<U>

A promise which resolves to an instance of the requested service, or rejects with an error if it cannot be resolved.

Notes

Services are singletons. The same instance will be returned each time a given service token is resolved.

If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.

User code will not typically call this method directly. Instead, the required services for the user’s plugins will be resolved automatically when the plugin is activated.

Inherited from

Application.resolveRequiredService

Defined in

node_modules/@lumino/application/types/index.d.ts:190


start

start(options?): Promise<void>

Start the application.

Parameters

Name

Type

Description

options?

IStartOptions

The options for starting the application.

Returns

Promise<void>

A promise which resolves when all bootstrapping work is complete and the shell is mounted to the DOM.

Notes

This should be called once by the application creator after all initial plugins have been registered.

If a plugin fails to the load, the error will be logged and the other valid plugins will continue to be loaded.

Bootstrapping the application consists of the following steps:

  1. Activate the startup plugins

  2. Wait for those plugins to activate

  3. Attach the shell widget to the DOM

  4. Add the application event listeners

Inherited from

Application.start

Defined in

node_modules/@lumino/application/types/index.d.ts:232