diff options
| author | Nitzan Uziely <linkgoron@gmail.com> | 2021-03-26 19:30:00 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2021-04-01 22:43:54 +0300 |
| commit | 54c525ef0e6d59ee43852e6d5ab1dbe3ab32b4e1 (patch) | |
| tree | 084e8c2faa36292c5beb25359ea74838d1921a88 /doc/api/readline.md | |
| parent | f87c4d126d0d6b6f59936adc0a7aaadc435f8908 (diff) | |
readline: add AbortSignal support to interface
Add abort signal support to Interface
PR-URL: https://github.com/nodejs/node/pull/37932
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
| -rw-r--r-- | doc/api/readline.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 4a8d8f20ac0..5081dc713fe 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -544,6 +544,9 @@ the current position of the cursor down. <!-- YAML added: v0.1.98 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/37932 + description: The `signal` option is supported now. - version: v15.8.0 pr-url: https://github.com/nodejs/node/pull/33662 description: The `history` option is supported now. @@ -601,6 +604,8 @@ changes: **Default:** `500`. * `tabSize` {integer} The number of spaces a tab is equal to (minimum 1). **Default:** `8`. + * `signal` {AbortSignal} Allows closing the interface using an AbortSignal. + Aborting the signal will internally call `close` on the interface. * Returns: {readline.Interface} The `readline.createInterface()` method creates a new `readline.Interface` |