Interface: ISessions#

session.ISessions

The interface for the sessions services.

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>

Defined in#

packages/session/lib/tokens.d.ts:16


list#

list(): Promise<IModel[]>

List the running sessions

Returns#

Promise<IModel[]>

Defined in#

packages/session/lib/tokens.d.ts:20


patch#

patch(options): Promise<IModel>

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

Parameters#

Name

Type

Description

options

IModel

The options to patch the session.

Returns#

Promise<IModel>

Defined in#

packages/session/lib/tokens.d.ts:27


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>

Defined in#

packages/session/lib/tokens.d.ts:39


startNew#

startNew(options): Promise<IModel>

Start a new session.

Parameters#

Name

Type

Description

options

IModel

The options to start a new session.

Returns#

Promise<IModel>

Defined in#

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