Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace KernelMessage

Index

Type aliases

Channel

Channel: "shell" | "control" | "iopub" | "stdin"

The valid Jupyter channel names in a message to a frontend.

ControlMessageType

ControlMessageType: "debug_request" | "debug_reply"

Control message types.

Notes

Debug messages are experimental messages that are not in the official kernel message specification. As such, debug message types are NOT considered part of the public API, and may change without notice.

IOPubMessageType

IOPubMessageType: "clear_output" | "comm_close" | "comm_msg" | "comm_open" | "display_data" | "error" | "execute_input" | "execute_result" | "shutdown_reply" | "status" | "stream" | "update_display_data" | "debug_event"

IOPub message types.

Notes

Debug messages are experimental messages that are not in the official kernel message specification. As such, debug message types are NOT considered part of the public API, and may change without notice.

IShellControlMessage

IShellControlMessage: IShellMessage | IControlMessage

A message type for shell or control messages.

Notes

This convenience is so we can use it as a generic type constraint.

Message

Message types.

Notes

Debug messages are experimental messages that are not in the official kernel message specification. As such, debug message types are NOT considered part of the public API, and may change without notice.

MessageType

Jupyter message types.

ShellMessageType

ShellMessageType: "comm_close" | "comm_info_reply" | "comm_info_request" | "comm_msg" | "comm_open" | "complete_reply" | "complete_request" | "execute_reply" | "execute_request" | "history_reply" | "history_request" | "inspect_reply" | "inspect_request" | "interrupt_reply" | "interrupt_request" | "is_complete_reply" | "is_complete_request" | "kernel_info_reply" | "kernel_info_request" | "shutdown_request"

Shell message types.

Status

Status: "unknown" | "starting" | "idle" | "busy" | "terminating" | "restarting" | "autorestarting" | "dead"

The valid Kernel status states.

Notes

The status states are:

  • unknown: The kernel status is unknown, often because the connection is disconnected or connecting. This state is determined by the kernel connection status.
  • autorestarting: The kernel is restarting, initiated by the server. This state is set by the services library, not explicitly sent from the kernel.
  • starting: The kernel is starting
  • idle: The kernel has finished processing messages.
  • busy: The kernel is currently processing messages.
  • restarting: The kernel is restarting. This state is sent by the Jupyter server.
  • dead: The kernel is dead and will not be restarted. This state is set by the Jupyter server and is a final state.

StdinMessageType

StdinMessageType: "input_request" | "input_reply"

Stdin message types.

Functions

createMessage

  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • createMessage<T>(options: IOptions<T>): T
  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    Returns T

isClearOutputMsg

  • Test whether a kernel message is a 'clear_output' message.

    Parameters

    Returns msg is IClearOutputMsg

isCommCloseMsg

  • Test whether a kernel message is a 'comm_close' message.

    Parameters

    Returns msg is ICommCloseMsg<"iopub" | "shell">

isCommMsgMsg

  • Test whether a kernel message is a 'comm_msg' message.

    Parameters

    Returns msg is ICommMsgMsg<"iopub" | "shell">

isCommOpenMsg

  • Test whether a kernel message is a 'comm_open' message.

    Parameters

    Returns msg is ICommOpenMsg<"iopub" | "shell">

isDisplayDataMsg

  • Test whether a kernel message is an 'display_data' message.

    Parameters

    Returns msg is IDisplayDataMsg

isErrorMsg

  • Test whether a kernel message is an 'error' message.

    Parameters

    Returns msg is IErrorMsg

isExecuteInputMsg

  • Test whether a kernel message is an 'execute_input' message.

    Parameters

    Returns msg is IExecuteInputMsg

isExecuteReplyMsg

  • Test whether a kernel message is an 'execute_reply' message.

    Parameters

    Returns msg is IExecuteReplyMsg

isExecuteResultMsg

  • Test whether a kernel message is an 'execute_result' message.

    Parameters

    Returns msg is IExecuteResultMsg

isInfoRequestMsg

  • Test whether a kernel message is a 'kernel_info_request' message.

    Parameters

    Returns msg is IInfoRequestMsg

isInputReplyMsg

  • Test whether a kernel message is an 'input_reply' message.

    Parameters

    Returns msg is IInputReplyMsg

isInputRequestMsg

  • Test whether a kernel message is an 'input_request' message.

    Parameters

    Returns msg is IInputRequestMsg

isStatusMsg

  • Test whether a kernel message is a 'status' message.

    Parameters

    Returns msg is IStatusMsg

isStreamMsg

  • Test whether a kernel message is a 'stream' message.

    Parameters

    Returns msg is IStreamMsg

isUpdateDisplayDataMsg

  • Test whether a kernel message is an 'update_display_data' message.

    Parameters

    Returns msg is IUpdateDisplayDataMsg

Generated using TypeDoc