***`
@jupyterlite / @jupyterlite/kernel / LiteKernelClient
Class: LiteKernelClient#
Defined in: packages/services/lib/kernel/client.d.ts:9
A class to handle requests to /api/kernels
Implements#
IKernelAPIClient
Constructors#
Constructor#
**new LiteKernelClient**(options):LiteKernelClient
Defined in: packages/services/lib/kernel/client.d.ts:15
Construct a new Kernels
Parameters#
options#
The instantiation options
Returns#
LiteKernelClient
Accessors#
changed#
Get Signature#
**get****changed**():ISignal<this,IChangedArgs<IKernel>>
Defined in: packages/services/lib/kernel/client.d.ts:23
Signal emitted when the kernels map changes
Returns#
ISignal<this, IChangedArgs<IKernel>>
`***
serverSettings#
Get Signature#
getserverSettings():ISettings
Defined in: packages/services/lib/kernel/client.d.ts:19
The server settings for the kernel client.
Returns#
ISettings
Implementation of#
Kernel.IKernelAPIClient.serverSettings
Methods#
getModel()#
getModel(id):Promise<undefined|IKernel>
Defined in: packages/services/lib/kernel/client.d.ts:57
Get a kernel by id
Parameters#
id#
string
Returns#
Promise<undefined | IKernel>
Implementation of#
Kernel.IKernelAPIClient.getModel
***`
handleStdin()#
**handleStdin**(inputRequest):Promise<IInputReplyMsg>
Defined in: packages/services/lib/kernel/client.d.ts:61
Handle stdin request received from Service Worker.
Parameters#
inputRequest#
IInputRequestMsg
Returns#
Promise<IInputReplyMsg>
`***
interrupt()#
interrupt(kernelId):Promise<void>
Defined in: packages/services/lib/kernel/client.d.ts:39
Interrupt a kernel.
Parameters#
kernelId#
string
Returns#
Promise<void>
Implementation of#
Kernel.IKernelAPIClient.interrupt
***`
listRunning()#
**listRunning**():Promise<IModel[]>
Defined in: packages/services/lib/kernel/client.d.ts:43
List the running kernels.
Returns#
Promise<IModel[]>
Implementation of#
Kernel.IKernelAPIClient.listRunning
`***
restart()#
restart(kernelId):Promise<void>
Defined in: packages/services/lib/kernel/client.d.ts:35
Restart a kernel.
Parameters#
kernelId#
string
The kernel id.
Returns#
Promise<void>
Implementation of#
Kernel.IKernelAPIClient.restart
***`
shutdown()#
**shutdown**(id):Promise<void>
Defined in: packages/services/lib/kernel/client.d.ts:49
Shut down a kernel.
Parameters#
id#
string
The kernel id.
Returns#
Promise<void>
Implementation of#
Kernel.IKernelAPIClient.shutdown
`***
shutdownAll()#
shutdownAll():Promise<void>
Defined in: packages/services/lib/kernel/client.d.ts:53
Shut down all kernels.
Returns#
Promise<void>
***`
startNew()#
**startNew**(options):Promise\<IModel`>
Defined in: packages/services/lib/kernel/client.d.ts:29
Start a new kernel.
Parameters#
options#
The kernel start options.
Returns#
Promise<IModel>
Implementation of#
Kernel.IKernelAPIClient.startNew