Interface: ISessions

session.ISessions

The interface for the sessions services.

Properties

patch

patch: (options: IModel) => Promise<IModel>

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

param The options to patch the session.

Type declaration

▸ (options): Promise<IModel>

Parameters

Name

Type

options

IModel

Returns

Promise<IModel>

Defined in

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


shutdown

shutdown: (id: string) => Promise<void>

Shut down a session.

param The id of the session to shut down.

Type declaration

▸ (id): Promise<void>

Parameters

Name

Type

id

string

Returns

Promise<void>

Defined in

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


startNew

startNew: (options: IModel) => Promise<IModel>

Start a new session.

param The options to start a new session.

Type declaration

▸ (options): Promise<IModel>

Parameters

Name

Type

options

IModel

Returns

Promise<IModel>

Defined in

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

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