Interface: ISessions
#
@jupyterlite/session.ISessions
The interface for the sessions services.
Properties#
patch
#
patch
: (options
:IModel
) =>Promise
<IModel
>
Type declaration#
(
options
):Promise
<IModel
>
Path an existing session. This can be used to rename a session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The options to patch the session. |
Returns#
Promise
<IModel
>
Defined in#
shutdown
#
shutdown
: (id
:string
) =>Promise
<void
>
Type declaration#
(
id
):Promise
<void
>
Shut down a session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The id of the session to shut down. |
Returns#
Promise
<void
>
Defined in#
startNew
#
startNew
: (options
:IModel
) =>Promise
<IModel
>
Type declaration#
(
options
):Promise
<IModel
>
Start a new session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The options to start a new session. |
Returns#
Promise
<IModel
>
Defined in#
Methods#
get
#
get
(id
):Promise
<IModel
>
Get a session by id.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The id of the session. |
Returns#
Promise
<IModel
>
Defined in#
list
#
list
():Promise
<IModel
[]>
List the running sessions
Returns#
Promise
<IModel
[]>