@jupyterlite / @jupyterlite/kernel / IKernelClient
Interface: IKernelClient#
Defined in: packages/services/lib/kernel/tokens.d.ts:15
An interface for the Kernels service.
Extends#
IKernelAPIClient
Properties#
changed#
readonlychanged:ISignal<IKernelClient,IChangedArgs<IKernel>>
Defined in: packages/services/lib/kernel/tokens.d.ts:23
Signal emitted when the kernels map changes
serverSettings#
readonlyserverSettings:ISettings
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:860
The server settings for the client.
Inherited from#
Kernel.IKernelAPIClient.serverSettings
shutdownAll()#
shutdownAll: () =>
Promise<void>
Defined in: packages/services/lib/kernel/tokens.d.ts:31
Shut down all kernels.
Returns#
Promise<void>
Methods#
getModel()#
getModel(
id):Promise<undefined|IModel>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:874
Get a kernel model.
Parameters#
id#
string
The id of the kernel of interest.
Returns#
Promise<undefined | IModel>
A promise that resolves with the kernel model.
Inherited from#
Kernel.IKernelAPIClient.getModel
handleStdin()#
handleStdin(
inputRequest):Promise<IInputReplyMsg>
Defined in: packages/services/lib/kernel/tokens.d.ts:27
Handle stdin request received from Service Worker.
Parameters#
inputRequest#
IInputRequestMsg
Returns#
Promise<IInputReplyMsg>
interrupt()#
interrupt(
id):Promise<void>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:898
Interrupt a kernel.
Parameters#
id#
string
The id of the kernel to interrupt.
Returns#
Promise<void>
A promise that resolves when the kernel is interrupted.
Inherited from#
Kernel.IKernelAPIClient.interrupt
listRunning()#
listRunning():
Promise<IModel[]>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:866
List the running kernels.
Returns#
Promise<IModel[]>
A promise that resolves with the list of running kernel models.
Inherited from#
Kernel.IKernelAPIClient.listRunning
restart()#
restart(
id):Promise<void>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:890
Restart a kernel.
Parameters#
id#
string
The id of the kernel to restart.
Returns#
Promise<void>
A promise that resolves when the kernel is restarted.
Inherited from#
Kernel.IKernelAPIClient.restart
shutdown()#
shutdown(
id):Promise<void>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:906
Shut down a kernel by id.
Parameters#
id#
string
The id of the kernel to shut down.
Returns#
Promise<void>
A promise that resolves when the kernel is shut down.
Inherited from#
Kernel.IKernelAPIClient.shutdown
startNew()#
startNew(
options?):Promise<IModel>
Defined in: node_modules/@jupyterlab/services/lib/kernel/kernel.d.ts:882
Start a new kernel.
Parameters#
options?#
Partial<Pick<IModel, "name">>
The options used to create the kernel.
Returns#
Promise<IModel>
A promise that resolves with the kernel model.
Inherited from#
Kernel.IKernelAPIClient.startNew