@jupyterlite / @jupyterlite/kernel / IKernel
Interface: IKernel#
Defined in: packages/services/lib/kernel/tokens.d.ts:45
An interface for a kernel running in the browser.
Extends#
IObservableDisposable
Properties#
disposed#
readonlydisposed: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#
readonlyid:string
Defined in: packages/services/lib/kernel/tokens.d.ts:49
The id of the server-side kernel.
isDisposed#
readonlyisDisposed: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#
readonlylocation:string
Defined in: packages/services/lib/kernel/tokens.d.ts:57
The location in the virtual filesystem from which the kernel was started.
name#
readonlyname:string
Defined in: packages/services/lib/kernel/tokens.d.ts:53
The name of the server-side kernel.
ready#
readonlyready:Promise<void>
Defined in: packages/services/lib/kernel/tokens.d.ts:61
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/services/lib/kernel/tokens.d.ts:67
Handle an incoming message from the client.
Parameters#
msg#
IMessage
The message to handle
Returns#
Promise<void>