Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKernel

Hierarchy

  • IKernel

Index

Properties

Readonly id

id: string

Readonly info

The cached kernel info.

Notes

This value will be null until the kernel is ready.

Readonly isReady

isReady: boolean

Test whether the kernel is ready.

Readonly name

name: string

Readonly ready

ready: Thenable<void>

A Thenable that is fulfilled when the kernel is ready.

Optional Readonly requiresConnection

requiresConnection: boolean

Readonly supportsIntellisense

supportsIntellisense: boolean

Methods

getSpec

  • Gets the full specification for this kernel, which can be serialized to a notebook file

    Returns Thenable<IKernelSpec>

interrupt

  • interrupt(): Thenable<void>
  • Interrupt a kernel.

    Notes

    Uses the Jupyter Notebook API.

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

    It is assumed that the API call does not mutate the kernel id or name.

    The promise will be rejected if the kernel status is Dead or if the request fails or the response is invalid.

    Returns Thenable<void>

requestComplete

  • Send a complete_request message.

    Parameters

    Returns Thenable<ICompleteReplyMsg>

    A Thenable that resolves with the response message.

    Notes

    See Messaging in Jupyter.

    Fulfills with the complete_reply content when the shell reply is received and validated.

requestExecute

  • Send an execute_request message.

    Parameters

    • content: IExecuteRequest

      The content of the request.

    • Optional disposeOnDone: boolean

      Whether to dispose of the future when done.

    Returns IFuture

    A kernel future.

    Notes

    See Messaging in Jupyter.

    This method returns a kernel future, rather than a Thenable, since execution may have many response messages (for example, many iopub display messages).

    Future onReply is called with the execute_reply content when the shell reply is received and validated.

    See also: IExecuteReply

Generated using TypeDoc