Class: Kernels#

@jupyterlite/kernel.Kernels

A class to handle requests to /api/kernels

Implements#

Constructors#

constructor#

new Kernels(options)

Construct a new Kernels

Parameters#

Name

Type

Description

options

IOptions

The instantiation options

Defined in#

packages/kernel/src/kernels.ts:34

Properties#

_clients#

Private _clients: ObservableMap<Client>

Defined in#

packages/kernel/src/kernels.ts:238

_kernelClients#

Private _kernelClients: ObservableMap<Set<string>>

Defined in#

packages/kernel/src/kernels.ts:239

_kernels#

Private _kernels: ObservableMap<IKernel>

Defined in#

packages/kernel/src/kernels.ts:237

_kernelspecs#

Private _kernelspecs: IKernelSpecs

Defined in#

packages/kernel/src/kernels.ts:240

Methods#

get#

get(id): Promise<undefined | IKernel>

Get a kernel by id

Parameters#

Name

Type

id

string

Returns#

Promise<undefined | IKernel>

Implementation of#

IKernels.get

Defined in#

packages/kernel/src/kernels.ts:233

list#

list(): Promise<IModel[]>

List the running kernels.

Returns#

Promise<IModel[]>

Implementation of#

IKernels.list

Defined in#

packages/kernel/src/kernels.ts:214

restart#

restart(kernelId): Promise<IModel>

Restart a kernel.

Parameters#

Name

Type

Description

kernelId

string

The kernel id.

Returns#

Promise<IModel>

Implementation of#

IKernels.restart

Defined in#

packages/kernel/src/kernels.ts:201

shutdown#

shutdown(id): Promise<void>

Shut down a kernel.

Parameters#

Name

Type

Description

id

string

The kernel id.

Returns#

Promise<void>

Implementation of#

IKernels.shutdown

Defined in#

packages/kernel/src/kernels.ts:226

startNew#

startNew(options): Promise<IModel>

Start a new kernel.

Parameters#

Name

Type

Description

options

IKernelOptions

The kernel start options.

Returns#

Promise<IModel>

Implementation of#

IKernels.startNew

Defined in#

packages/kernel/src/kernels.ts:44