KernelAPIClient | @jupyterlab (original) (raw)

Implements

• IKernelAPIClient

Index

Constructors

constructor

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

• Returns KernelAPIClient

Properties

ReadonlyserverSettings

Methods

getModel

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

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

• 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[]>

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

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

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

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