Interface IStreamMsg

A 'stream' message on the 'iopub' channel.

interface IStreamMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "iopub";
    content: {
        name: "stdout" | "stderr";
        text: string;
    };
    header: IHeader<"stream">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;
}

Hierarchy (view full)

IIOPubMessage<"stream">
- IStreamMsg

Index

Properties

buffers? channel content header metadata parent_header

Properties

`Optional` buffers

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel

channel: "iopub"

The channel on which the message is transmitted.

content

content: {
name: "stdout" | "stderr";
text: string;
}

The content of the message.

Type declaration

name: "stdout" | "stderr"
text: string

header

header: IHeader<"stream">

The message header.

metadata

metadata: JSONObject

Metadata associated with the message.

parent_header

parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>

The parent message