Class Kernel

Jupyter Kernel handler

Constructors

constructor

Properties

_clientId _connectionStatus _id _info? _kernelConnection _kernelManager _kernelName _kernelSpecManager _kernelSpecName _kernelType _path _ready _session _sessionId _sessionManager

Accessors

clientId connection cookieName id info kernelManager kernelSpecManager path ready session sessionId sessionManager

Methods

execute interrupt requestKernel restart shutdown toJSON toString

Constructors

constructor

Properties

Private _clientId

_clientId: string

Private _connectionStatus

_connectionStatus: ConnectionStatus

Private _id

_id: string

Private Optional _info

_info?: IInfoReply

Private _kernelConnection

_kernelConnection: null | IKernelConnection

Private _kernelManager

_kernelManager: IManager

Private _kernelName

_kernelName: string

Private _kernelSpecManager

_kernelSpecManager: IManager

Private _kernelSpecName

_kernelSpecName: string

Private _kernelType

_kernelType: string

Private _path

_path: string

Private _ready

_ready: PromiseDelegate<void>

Private _session

_session: ISessionConnection

Private _sessionId

_sessionId: string

Private _sessionManager

_sessionManager: IManager

Accessors

clientId

connection

cookieName

id

info

kernelManager

kernelSpecManager

path

ready

session

sessionId

sessionManager

Methods

execute

  • execute(code, options?): undefined | KernelExecutor

  • Execute a code snippet

    Parameters

    • code: string

      The code snippet

    • options: {
          allowStdin?: boolean;
          iopubMessageHooks?: IOPubMessageHook[];
          model?: IOutputAreaModel;
          onExecutionPhaseChanged?: ((phaseOutput) => void);
          shellMessageHooks?: ShellMessageHook[];
          silent?: boolean;
          stopOnError?: boolean;
          storeHistory?: boolean;
          suppressCodeExecutionErrors?: boolean;
      } = {}

      Callbacks on IOPub messages and on reply message, outputs model to populate and execution options

      • Optional allowStdin?: boolean
      • Optional iopubMessageHooks?: IOPubMessageHook[]
      • Optional model?: IOutputAreaModel
      • Optional onExecutionPhaseChanged?: ((phaseOutput) => void)
      • Optional shellMessageHooks?: ShellMessageHook[]
      • Optional silent?: boolean
      • Optional stopOnError?: boolean
      • Optional storeHistory?: boolean
      • Optional suppressCodeExecutionErrors?: boolean

    Returns undefined | KernelExecutor

    The kernel executor

interrupt

Private requestKernel

restart

shutdown

toJSON

  • toJSON(): {
        clientId: string;
        id: string;
        kernelInfo: undefined | IInfoReply;
        path: string;
        sessionId: string;
    }

  • Serialize the kernel to JSON

    Returns {
        clientId: string;
        id: string;
        kernelInfo: undefined | IInfoReply;
        path: string;
        sessionId: string;
    }

    • clientId: string
    • id: string
    • kernelInfo: undefined | IInfoReply
    • path: string
    • sessionId: string

toString

Settings

Member Visibility

Theme

On This Page

constructor_clientId_connectionStatus_id_info_kernelConnection_kernelManager_kernelName_kernelSpecManager_kernelSpecName_kernelType_path_ready_session_sessionId_sessionManagerclientIdconnectioncookieNameidinfokernelManagerkernelSpecManagerpathreadysessionsessionIdsessionManagerexecuteinterruptrequestKernelrestartshutdowntoJSONtoString