Interface: IKernels#

@jupyterlite/kernel.IKernels

An interface for the Kernels service.

Properties#

list#

list: () => Promise<IModel[]>

Type declaration#

(): Promise<IModel[]>

List the running kernels.

Returns#

Promise<IModel[]>

Defined in#

packages/kernel/src/tokens.ts:47

restart#

restart: (id: string) => Promise<IModel>

Type declaration#

(id): Promise<IModel>

Restart a kernel.

Parameters#

Name

Type

Description

id

string

The kernel id.

Returns#

Promise<IModel>

Defined in#

packages/kernel/src/tokens.ts:42

shutdown#

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

Type declaration#

(id): Promise<void>

Shut down a kernel.

Parameters#

Name

Type

Description

id

string

The kernel id.

Returns#

Promise<void>

Defined in#

packages/kernel/src/tokens.ts:54

startNew#

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

Type declaration#

(options): Promise<IModel>

Start a new kernel.

Parameters#

Name

Type

Description

options

IKernelOptions

The kernel startup options.

Returns#

Promise<IModel>

Defined in#

packages/kernel/src/tokens.ts:35

Methods#

get#

get(id): Promise<undefined | IKernel>

Get a kernel by id

Parameters#

Name

Type

Description

id

string

The kernel id.

Returns#

Promise<undefined | IKernel>

the kernel if it exists, undefined otherwise.

Defined in#

packages/kernel/src/tokens.ts:62