@jupyterlite

***`

@jupyterlite / @jupyterlite/kernel / IKernel

Interface: IKernel#

Defined in: packages/kernel/src/tokens.ts:67

An interface for a kernel running in the browser.

Extends#

  • IObservableDisposable

Properties#

disposed#

readonly **disposed**: ISignal<IKernel, void>

Defined in: node_modules/@lumino/disposable/types/index.d.ts:37

A signal emitted when the object is disposed.

Inherited from#

IObservableDisposable.disposed

`***

id#

readonly id: string

Defined in: packages/kernel/src/tokens.ts:71

The id of the server-side kernel.

***`

isDisposed#

readonly **isDisposed**: boolean

Defined in: node_modules/@lumino/disposable/types/index.d.ts:16

Test whether the object has been disposed.

Notes#

This property is always safe to access.

Inherited from#

IObservableDisposable.isDisposed

`***

location#

readonly location: string

Defined in: packages/kernel/src/tokens.ts:81

The location in the virtual filesystem from which the kernel was started.

***`

name#

readonly **name**: string

Defined in: packages/kernel/src/tokens.ts:76

The name of the server-side kernel.

`***

ready#

readonly ready: Promise<void>

Defined in: packages/kernel/src/tokens.ts:86

A promise that is fulfilled when the kernel is ready.

Methods#

dispose()#

dispose(): void

Defined in: node_modules/@lumino/disposable/types/index.d.ts:28

Dispose of the resources held by the object.

Notes#

If the object’s dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior#

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns#

void

Inherited from#

IObservableDisposable.dispose

***`

handleMessage()#

**handleMessage**(msg): Promise\<void`>

Defined in: packages/kernel/src/tokens.ts:93

Handle an incoming message from the client.

Parameters#

msg#

IMessage

The message to handle

Returns#

Promise<void>