Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace KernelAPI

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

IKernelOptions

IKernelOptions: Partial<Pick<IModel, "name">>

The options object used to initialize a kernel.

Variables

Const KERNEL_SERVICE_URL

KERNEL_SERVICE_URL: "api/kernels" = "api/kernels"

The url for the kernel service.

Functions

getKernelModel

  • getKernelModel(id: string, settings?: ISettings): Promise<IModel | undefined>

  • Get a full kernel model from the server by kernel id string.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

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

    Parameters

    Returns Promise<IModel | undefined>

interruptKernel

  • interruptKernel(id: string, settings?: ISettings): Promise<void>

  • Interrupt a kernel.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

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

    Parameters

    Returns Promise<void>

listRunning

  • Fetch the running kernels.

    Parameters

    • Optional settings: ISettings

      The optional server settings.

    Returns Promise<IModel[]>

    A promise that resolves with the list of running kernels.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

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

restartKernel

  • restartKernel(id: string, settings?: ISettings): Promise<void>

  • Restart a kernel.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

    The promise is fulfilled on a valid response (and thus after a restart) and rejected otherwise.

    Parameters

    Returns Promise<void>

shutdownKernel

  • shutdownKernel(id: string, settings?: ISettings): Promise<void>

  • Shut down a kernel.

    Parameters

    • id: string

      The id of the running kernel.

    • Optional settings: ISettings

      The server settings for the request.

    Returns Promise<void>

    A promise that resolves when the kernel is shut down.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

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

startNew

  • Start a new kernel.

    Parameters

    Returns Promise<IModel>

    A promise that resolves with a kernel connection object.

    Notes

    Uses the Jupyter Notebook API and validates the response model.

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

Generated using TypeDoc