Class KernelAPIClient

constructor

• new KernelAPIClient(
      options?: { serverSettings?: ServerConnection.ISettings },
  ): KernelAPIClient

• Create a new kernel API client.

  Parameters

  • options: { serverSettings?: ServerConnection.ISettings } = {}

    The options used to create the client.

  Returns KernelAPIClient

ReadonlyserverSettings

getModel

• getModel(id: string): Promise<undefined | Kernel.IModel>

• Get a kernel model.

  Parameters

  • id: string

    The id of the kernel of interest.

  Returns Promise<undefined | Kernel.IModel>

  A promise that resolves with the kernel model.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise. If the kernel does not exist on the server, the promise is resolved with undefined.

interrupt

• interrupt(id: string): Promise<void>

• 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.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

listRunning

• listRunning(): Promise<Kernel.IModel[]>

• List the running kernels.

  Returns Promise<Kernel.IModel[]>

  A promise that resolves with the list of running kernel models.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

restart

• restart(id: string): Promise<void>

• 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.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

shutdown

• shutdown(id: string): Promise<void>

• 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.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

startNew

• startNew(options?: Partial<Pick<Kernel.IModel, "name">>): Promise<Kernel.IModel>

• Start a new kernel.

  Parameters

  • options: Partial<Pick<Kernel.IModel, "name">> = {}

    The options used to create the kernel.

  Returns Promise<Kernel.IModel>

  A promise that resolves with the kernel model.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.