The valid Kernel status states.
Connect to a running kernel.
The model of the running kernel.
The server settings for the request.
The kernel object.
If the kernel was already started via startNewKernel
, the existing
Kernel object info is used to create another instance.
Find a kernel by id.
The id of the kernel of interest.
The optional server settings.
A promise that resolves with the model for the kernel.
If the kernel was already started via startNewKernel
, we return its
Kernel.IModel
. Otherwise, we attempt to find the existing kernel. The
promise is fulfilled when the kernel is found, otherwise the promise is
rejected.
Fetch all of the kernel specs.
The optional server settings.
A promise that resolves with the kernel specs.
Uses the Jupyter Notebook API.
Fetch the running kernels.
The optional server settings.
A promise that resolves with the list of running kernels.
Uses the Jupyter Notebook API and validates the response model.
The promise is fulfilled on a valid response and rejected otherwise.
Shut down a kernel by id.
The id of the running kernel.
The server settings for the request.
A promise that resolves when the kernel is shut down.
Shut down all kernels.
A promise that resolves when all of the kernels are shut down.
Start a new kernel.
The options used to create the kernel.
A promise that resolves with a kernel object.
Uses the Jupyter Notebook API and validates the response model.
If no options are given or the kernel name is not given, the default kernel will by started by the server.
Wraps the result in a Kernel object. The promise is fulfilled when the kernel is started by the server, otherwise the promise is rejected.
Generated using TypeDoc
A namespace for kernel types, interfaces, and type checker functions.