Class: Sessions#

session.Sessions

A class to handle requests to /api/sessions

Implements#

Constructors#

constructor#

new Sessions(options)

Construct a new Sessions.

Parameters#

Name

Type

Description

options

IOptions

The instantiation options for a Sessions.

Defined in#

packages/session/lib/sessions.d.ts:13

Properties#

_kernels#

Private _kernels: any

Defined in#

packages/session/lib/sessions.d.ts:47


_sessions#

Private _sessions: any

Defined in#

packages/session/lib/sessions.d.ts:48

Methods#

get#

get(id): Promise<IModel>

Get a session by id.

Parameters#

Name

Type

Description

id

string

The id of the session.

Returns#

Promise<IModel>

Implementation of#

ISessions.get

Defined in#

packages/session/lib/sessions.d.ts:19


list#

list(): Promise<IModel[]>

List the running sessions

Returns#

Promise<IModel[]>

Implementation of#

ISessions.list

Defined in#

packages/session/lib/sessions.d.ts:23


patch#

patch(options): Promise<IModel>

Path an existing session. This can be used to rename a session.

  • path updates session to track renamed paths

  • kernel.name starts a new kernel with a given kernelspec

Parameters#

Name

Type

Description

options

IModel

The options to patch the session.

Returns#

Promise<IModel>

Implementation of#

ISessions.patch

Defined in#

packages/session/lib/sessions.d.ts:33


shutdown#

shutdown(id): Promise<void>

Shut down a session.

Parameters#

Name

Type

Description

id

string

The id of the session to shut down.

Returns#

Promise<void>

Implementation of#

ISessions.shutdown

Defined in#

packages/session/lib/sessions.d.ts:46


startNew#

startNew(options): Promise<IModel>

Start a new session TODO: read path and name

Parameters#

Name

Type

Description

options

IModel

The options to start a new session.

Returns#

Promise<IModel>

Implementation of#

ISessions.startNew

Defined in#

packages/session/lib/sessions.d.ts:40