Interface IInspectRequestMsg

An 'inspect_request' message.

See Messaging in Jupyter.

See also: [[IInspectReplyMsg]], [[[IKernel.inspect]]]

interface IInspectRequestMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "shell";
    content: {
        code: string;
        cursor_pos: number;
        detail_level: 0 | 1;
    };
    header: IHeader<"inspect_request">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;
}

Hierarchy (view full)

Properties

buffers? channel content header metadata parent_header

Properties

Optional buffers

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel

channel: "shell"

The channel on which the message is transmitted.

content

content: {
    code: string;
    cursor_pos: number;
    detail_level: 0 | 1;
}

The content of the message.

Type declaration

  • code: string
  • cursor_pos: number
  • detail_level: 0 | 1

header

header: IHeader<"inspect_request">

The message header.

metadata

metadata: JSONObject

Metadata associated with the message.

parent_header

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

The parent message

Settings

Member Visibility

Theme

On This Page

bufferschannelcontentheadermetadataparent_header