Class: Kernels

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/lib/kernels.d.ts:6

Properties

_clients

Private _clients: any

Defined in

packages/kernel/lib/kernels.d.ts:32


_kernelClients

Private _kernelClients: any

Defined in

packages/kernel/lib/kernels.d.ts:33


_kernels

Private _kernels: any

Defined in

packages/kernel/lib/kernels.d.ts:31


_kernelspecs

Private _kernelspecs: any

Defined in

packages/kernel/lib/kernels.d.ts:34

Methods

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/lib/kernels.d.ts:24


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/lib/kernels.d.ts:30


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/lib/kernels.d.ts:18