Class: JupyterLiteServer
#
@jupyterlite/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 |
---|---|---|
|
|
The instantiation options for a JupyterLiteServer application. |
Overrides#
Application<never>.constructor
Defined in#
Properties#
_router
#
Private
_router
:Router
Defined in#
_serviceManager
#
Private
_serviceManager
:ServiceManager
Defined in#
commands
#
Readonly
commands
:CommandRegistry
The application command registry.
Inherited from#
Application.commands
Defined in#
node_modules/@lumino/application/types/index.d.ts:32
name
#
Readonly
name
:"JupyterLite Server"
The name of the application.
Defined in#
namespace
#
Readonly
namespace
:"JupyterLite Server"
A namespace/prefix plugins may use to denote their provenance.
Defined in#
pluginRegistry
#
Protected
pluginRegistry
:PluginRegistry
<any
>
Application plugin registry.
Inherited from#
Application.pluginRegistry
Defined in#
node_modules/@lumino/application/types/index.d.ts:283
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:45
version
#
Readonly
version
:"unknown"
The version of the application.
Defined in#
Accessors#
deferredPlugins
#
get
deferredPlugins
():string
[]
The list of all the deferred plugins.
Returns#
string
[]
Inherited from#
Application.deferredPlugins
Defined in#
node_modules/@lumino/application/types/index.d.ts:49
router
#
get
router
():Router
Get the underlying Router
instance.
Returns#
Defined in#
serviceManager
#
get
serviceManager
():ServiceManager
Get the underlying lite service manager for this app.
Returns#
ServiceManager
Defined in#
started
#
get
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.
Returns#
Promise
<void
>
Inherited from#
Application.started
Defined in#
node_modules/@lumino/application/types/index.d.ts:57
Methods#
activateDeferredPlugins
#
activateDeferredPlugins
():Promise
<void
>
Activate all the deferred plugins.
Returns#
Promise
<void
>
A promise which will resolve when each plugin is activated or rejects with an error if one cannot be activated.
Inherited from#
Application.activateDeferredPlugins
Defined in#
node_modules/@lumino/application/types/index.d.ts:64
activatePlugin
#
activatePlugin
(id
):Promise
<void
>
Activate the plugin with the given ID.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:73
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:236
attachShell
#
Protected
attachShell
(id
):void
Attach the application shell to the DOM.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The id of the host node for the shell, or |
Returns#
void
Overrides#
Application.attachShell
Defined in#
deactivatePlugin
#
deactivatePlugin
(id
):Promise
<string
[]>
Deactivate the plugin and its downstream dependents if and only if the
plugin and its dependents all support deactivate
.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The ID of the plugin of interest. |
Returns#
Promise
<string
[]>
A list of IDs of downstream plugins deactivated with this one.
Inherited from#
Application.deactivatePlugin
Defined in#
node_modules/@lumino/application/types/index.d.ts:82
deregisterPlugin
#
deregisterPlugin
(id
,force?
):void
Deregister a plugin with the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The ID of the plugin of interest. |
|
|
Whether to deregister the plugin even if it is active. |
Returns#
void
Inherited from#
Application.deregisterPlugin
Defined in#
node_modules/@lumino/application/types/index.d.ts:90
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 |
---|---|
|
|
Returns#
void
Inherited from#
Application.evtKeydown
Defined in#
node_modules/@lumino/application/types/index.d.ts:246
evtKeyup
#
Protected
evtKeyup
(event
):void
A method invoked on a document 'keyup'
event.
Notes#
The default implementation of this method invokes the key up processing method of the application command registry.
A subclass may reimplement this method as needed.
Parameters#
Name |
Type |
---|---|
|
|
Returns#
void
Inherited from#
Application.evtKeyup
Defined in#
node_modules/@lumino/application/types/index.d.ts:256
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 |
---|---|
|
|
Returns#
void
Overrides#
Application.evtResize
Defined in#
fetch
#
fetch
(req
,init?
):Promise
<Response
>
Handle an incoming request from the client.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The incoming request |
|
|
The optional init request |
Returns#
Promise
<Response
>
Defined in#
getPluginDescription
#
getPluginDescription
(id
):string
Get a plugin description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The ID of the plugin of interest. |
Returns#
string
The plugin description.
Inherited from#
Application.getPluginDescription
Defined in#
node_modules/@lumino/application/types/index.d.ts:98
handleEvent
#
handleEvent
(event
):void
Handle the DOM events for the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The DOM event sent to the application. #### Notes This method implements the DOM |
Returns#
void
Inherited from#
Application.handleEvent
Defined in#
node_modules/@lumino/application/types/index.d.ts:215
hasPlugin
#
hasPlugin
(id
):boolean
Test whether a plugin is registered with the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:106
isPluginActivated
#
isPluginActivated
(id
):boolean
Test whether a plugin is activated with the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The ID of the plugin of interest. |
Returns#
boolean
true
if the plugin is activated, false
otherwise.
Inherited from#
Application.isPluginActivated
Defined in#
node_modules/@lumino/application/types/index.d.ts:114
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:120
registerPlugin
#
registerPlugin
(plugin
):void
Register a plugin with the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:133
registerPluginModule
#
registerPluginModule
(mod
):void
Register plugins from a plugin module.
Parameters#
Name |
Type |
Description |
---|---|---|
|
The plugin module to register. |
Returns#
void
Defined in#
registerPluginModules
#
registerPluginModules
(mods
):void
Register the plugins from multiple plugin modules.
Parameters#
Name |
Type |
Description |
---|---|---|
|
The plugin modules to register. |
Returns#
void
Defined in#
registerPlugins
#
registerPlugins
(plugins
):void
Register multiple plugins with the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The plugins to register. #### Notes This calls |
Returns#
void
Inherited from#
Application.registerPlugins
Defined in#
node_modules/@lumino/application/types/index.d.ts:142
resolveOptionalService
#
resolveOptionalService
<U
>(token
):Promise
<null
|U
>
Resolve an optional service of a given type.
Type parameters#
Name |
---|
|
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:162
resolveRequiredService
#
resolveRequiredService
<U
>(token
):Promise
<U
>
Resolve a required service of a given type.
Type parameters#
Name |
---|
|
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:182
start
#
start
(options?
):Promise
<void
>
Start the application.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
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:
Activate the startup plugins
Wait for those plugins to activate
Attach the shell widget to the DOM
Add the application event listeners
Inherited from#
Application.start
Defined in#
node_modules/@lumino/application/types/index.d.ts:204