Interface IHeader<T>

Kernel message header content.

See Messaging in Jupyter.

See also: [[IMessage]]

interface IHeader<
    T extends KernelMessage.MessageType = KernelMessage.MessageType,
> {
    date: string;
    msg_id: string;
    msg_type: T;
    session: string;
    subshell_id?: string;
    username: string;
    version: string;
}

Type Parameters

Properties

date msg_id msg_type session subshell_id? username version

Properties

date

date: string

ISO 8601 timestamp for when the message is created

msg_id

msg_id: string

Message id, typically UUID, must be unique per message

msg_type

msg_type: T

Message type

session

session: string

Session id, typically UUID, should be unique per session.

Optionalsubshell_id

subshell_id?: string

Subshell id identifying a subshell if not in main shell

username

username: string

The user sending the message

version

version: string

The message protocol version, should be 5.1, 5.2, 5.3, etc.

Settings

Member Visibility

On This Page

Properties