Interface ICommCloseMsg<T>

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

See Comm close.

interface ICommCloseMsg<T> {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: T;
    content: {
        comm_id: string;
        data: JSONObject;
    };
    header: IHeader<"comm_close">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;
}

Type Parameters

T extends "iopub" | "shell" = "iopub" | "shell"

Hierarchy (view full)

KernelMessage.IMessage<"comm_close">
- ICommCloseMsg

Index

Properties

buffers? channel content header metadata parent_header

Properties

`Optional` buffers

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel

channel: T

The channel on which the message is transmitted.

content

content: {
comm_id: string;
data: JSONObject;
}

The content of the message.

Type declaration

comm_id: string
data: JSONObject

header

header: IHeader<"comm_close">

The message header.

metadata

metadata: JSONObject

Metadata associated with the message.

parent_header

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

The parent message