An 'input_request' message on the 'stdin' channel.

See Messaging in Jupyter.

interface IInputRequestMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "stdin";
    content: {
        password: boolean;
        prompt: string;
    header: IHeader<"input_request">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;

Hierarchy (view full)


buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel: "stdin"

The channel on which the message is transmitted.

content: {
    password: boolean;
    prompt: string;

The content of the message.

Type declaration

  • password: boolean

    Whether the request is for a password. If so, the frontend shouldn't echo input.

  • prompt: string

    The text to show at the prompt.

header: IHeader<"input_request">

The message header.

metadata: JSONObject

Metadata associated with the message.

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

The parent message