Skip to main content

ReadLineOptions

interface ReadLineOptions

Properties Jump to heading

Jump to headinginput: ReadableStream
optional
Jump to headingoutput: WritableStream | undefined
optional
Jump to headingterminal: boolean | undefined
optional
Jump to headinghistory: string[] | undefined

Initial list of history lines. This option makes sense only if terminal is set to true by the user or by an internal output check, otherwise the history caching mechanism is not initialized at all.

optional
Jump to headinghistorySize: number | undefined
optional
Jump to headingprompt: string | undefined
optional
Jump to headingcrlfDelay: number | undefined
optional
Jump to headingremoveHistoryDuplicates: boolean | undefined

If true, when a new input line added to the history list duplicates an older one, this removes the older line from the list.

optional
Jump to headingescapeCodeTimeout: number | undefined
optional
Jump to headingtabSize: number | undefined
Back to top