GitHubJupyter
  • Preparing search index...
  • The search index is not available
@jupyterlab
  • @jupyterlab
  • services
  • KernelAPI
  • shutdownKernel

Function shutdownKernel

  • shutdownKernel(id: string, settings?: ServerConnection.ISettings): Promise<void>
  • Shut down a kernel.

    Parameters

    • id: string

      The id of the running kernel.

    • settings: ServerConnection.ISettings = ...

      The server settings for the request.

    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.

    • Defined in packages/services/src/kernel/restapi.ts:190

Settings

Member Visibility

On This Page

Notes
GitHubJupyter
@jupyterlab
  • Loading...

Generated using TypeDoc