Interface IExecuteRequestMsg

An execute_request message on the 'shell' channel.

interface IExecuteRequestMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "shell";
    content: {
        allow_stdin?: boolean;
        code: string;
        silent?: boolean;
        stop_on_error?: boolean;
        store_history?: boolean;
        user_expressions?: JSONObject;
    };
    header: IHeader<"execute_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: {
    allow_stdin?: boolean;
    code: string;
    silent?: boolean;
    stop_on_error?: boolean;
    store_history?: boolean;
    user_expressions?: JSONObject;
}

The content of the message.

Type declaration

  • Optional allow_stdin?: boolean

    Whether to allow stdin requests. The default is true.

  • code: string

    The code to execute.

  • Optional silent?: boolean

    Whether to execute the code as quietly as possible. The default is false.

  • Optional stop_on_error?: boolean

    Whether to the abort execution queue on an error. The default is false.

  • Optional store_history?: boolean

    Whether to store history of the execution. The default true if silent is False. It is forced to false if silent is true.

  • Optional user_expressions?: JSONObject

    A mapping of names to expressions to be evaluated in the kernel's interactive namespace.

header

header: IHeader<"execute_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