Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add history parameter #127

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add history parameter #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Every option is optional.
* `input` Readable stream to get input data from. (default `process.stdin`)
* `output` Writable stream to write prompts to. (default: `process.stdout`)
* `completer` Autocomplete callback (see [official api](https://nodejs.org/api/readline.html#readline_readline_createinterface_options) for details
* `history` History array, which will be appended to.

If silent is true, and the input is a TTY, then read will set raw
mode, and read character by character.
Expand Down
4 changes: 3 additions & 1 deletion src/read.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface Options<T extends string | number = string> {
terminal?: boolean
replace?: string,
completer?: Completer | AsyncCompleter,
history?: string[],
}

export async function read<T extends string | number = string> ({
Expand All @@ -29,6 +30,7 @@ export async function read<T extends string | number = string> ({
edit,
terminal,
replace,
history,
}: Options<T>): Promise<T | string> {
if (
typeof def !== 'undefined' &&
Expand Down Expand Up @@ -61,7 +63,7 @@ export async function read<T extends string | number = string> ({
output = m

return new Promise<string | T>((resolve, reject) => {
const rl = createInterface({ input, output, terminal, completer })
const rl = createInterface({ input, output, terminal, completer, history })
// TODO: add tests for timeout
/* c8 ignore start */
const timer = timeout && setTimeout(() => onError(new Error('timed out')), timeout)
Expand Down