Interface IOptions

The options to create a stdin widget.

interface IOptions {
    future: IShellFuture<IShellMessage<ShellMessageType>, IShellMessage<ShellMessageType>>;
    inputHistoryScope?: "global" | "session";
    parent_header: IHeader<"input_request">;
    password: boolean;
    prompt: string;
    translator?: ITranslator;
}

Index

Properties

future inputHistoryScope? parent_header password prompt translator?

Properties

future

future: IShellFuture<IShellMessage<ShellMessageType>, IShellMessage<ShellMessageType>>

The kernel future associated with the request.

`Optional` inputHistoryScope

inputHistoryScope?: "global" | "session"

Whether to split stdin line history by kernel session or keep globally accessible.

parent_header

parent_header: IHeader<"input_request">

The header of the input_request message.

password

password: boolean

Whether the input is a password.

prompt

prompt: string

The prompt text.

`Optional` `Readonly` translator

translator?: ITranslator

Translator