Options
All
  • Public
  • Public/Protected
  • All
Menu

Module KernelMessage

A namespace for kernel messages.

Index

Interfaces

Type aliases

Functions

Type aliases

Channel

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

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

ControlMessageType

ControlMessageType: never

Control message types.

IOPubMessageType

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

IOPub message types.

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: IClearOutputMsg | ICommCloseMsg<"iopub"> | ICommCloseMsg<"shell"> | ICommInfoReplyMsg | ICommInfoRequestMsg | ICommMsgMsg<"iopub"> | ICommMsgMsg<"shell"> | ICommOpenMsg<"iopub"> | ICommOpenMsg<"shell"> | ICompleteReplyMsg | ICompleteRequestMsg | IDisplayDataMsg | IErrorMsg | IExecuteInputMsg | IExecuteReplyMsg | IExecuteRequestMsg | IExecuteResultMsg | IHistoryReplyMsg | IHistoryRequestMsg | IInfoReplyMsg | IInfoRequestMsg | IInputReplyMsg | IInputRequestMsg | IInspectReplyMsg | IInspectRequestMsg | IIsCompleteReplyMsg | IIsCompleteRequestMsg | IStatusMsg | IStreamMsg | IUpdateDisplayDataMsg

MessageType

MessageType: IOPubMessageType | ShellMessageType | ControlMessageType | StdinMessageType

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_reply" | "shutdown_request"

Shell message types.

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

isClearOutputMsg

  • isClearOutputMsg(msg: IMessage): boolean

isCommCloseMsg

  • isCommCloseMsg(msg: IMessage): boolean

isCommMsgMsg

isCommOpenMsg

isDisplayDataMsg

  • isDisplayDataMsg(msg: IMessage): boolean

isErrorMsg

isExecuteInputMsg

  • isExecuteInputMsg(msg: IMessage): boolean

isExecuteReplyMsg

  • isExecuteReplyMsg(msg: IMessage): boolean

isExecuteResultMsg

  • isExecuteResultMsg(msg: IMessage): boolean

isInfoRequestMsg

  • isInfoRequestMsg(msg: IMessage): boolean

isInputReplyMsg

  • isInputReplyMsg(msg: IMessage): boolean

isInputRequestMsg

  • isInputRequestMsg(msg: IMessage): boolean

isStatusMsg

isStreamMsg

isUpdateDisplayDataMsg

  • isUpdateDisplayDataMsg(msg: IMessage): boolean

Generated using TypeDoc