0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api
Jeremy Albright bd9be0418a
doc: include line/cursor in readline documentation
Documents the existence and purpose of the `line` and `cursor`
properties.  `line` can be used for reading the current input value
during runtime, if reading from a TTY stream.  Both properties are
necessary when developing a custom CLI input process using `readline`
as a backend.

Refs: https://github.com/nodejs/node/issues/30347
Refs: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/40513

PR-URL: https://github.com/nodejs/node/pull/30667
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-12-07 23:06:25 +01:00
..
addons.md doc: revise addons introduction for brevity and clarity 2019-12-03 22:47:18 -08:00
assert.md assert: handle (deep) equal(NaN, NaN) as being identical 2019-12-07 00:43:51 +01:00
async_hooks.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
buffer.md doc: Buffer.toString(): add note about invalid data 2019-12-03 23:27:11 +01:00
child_process.md child_process: document kill() return value 2019-11-29 11:05:49 -05:00
cli.md esm: make specifier flag clearly experimental 2019-12-04 13:21:41 -08:00
cluster.md 2019-11-21, Version 13.2.0 (Current) 2019-11-21 17:14:59 -05:00
console.md doc, console: remove non-existant methods from docs 2019-11-13 07:40:51 +01:00
crypto.md crypto: forbid setting the PBKDF2 iter count to 0 2019-11-28 00:36:36 +01:00
debugger.md doc: add note about debugging worker_threads 2019-11-25 06:11:09 +01:00
deprecations.md doc: remove dashes 2019-10-26 08:39:41 -07:00
dgram.md 2019-11-05, Version 13.1.0 (Current) 2019-11-05 19:39:20 +01:00
dns.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
documentation.md doc: remove multiple consecutive blank lines 2019-08-31 15:27:58 -07:00
domain.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
errors.md 2019-12-03, Version 13.3.0 (Current) 2019-12-03 22:57:31 +01:00
esm.md esm: make specifier flag clearly experimental 2019-12-04 13:21:41 -08:00
events.md events: add captureRejection option 2019-12-03 12:14:46 +01:00
fs.md doc: remove usage of "Node" in favor of "Node.js" 2019-12-03 22:48:29 -08:00
globals.md doc: delete "a number of" things in the docs 2019-10-26 11:25:43 -07:00
http2.md 2019-12-03, Version 13.3.0 (Current) 2019-12-03 22:57:31 +01:00
http.md 2019-12-03, Version 13.3.0 (Current) 2019-12-03 22:57:31 +01:00
https.md 2019-11-21, Version 13.2.0 (Current) 2019-11-21 17:14:59 -05:00
index.md wasi: introduce initial WASI support 2019-11-30 18:06:39 +01:00
inspector.md doc: remove dashes 2019-10-26 08:39:41 -07:00
intl.md tools: support full-icu by default 2019-10-03 15:21:26 -07:00
modules.md doc: add missing 'added' versions to module.builtinModules 2019-11-30 01:52:34 +01:00
n-api.md doc: improve napi formatting 2019-12-05 10:33:59 -08:00
net.md doc: update socket.bufferSize text 2019-12-01 20:51:31 -08:00
os.md doc: revise os.md 2019-10-26 16:10:12 -07:00
path.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
perf_hooks.md doc: fix typographical error 2019-12-02 08:28:19 -08:00
policy.md doc: remove dashes 2019-10-26 08:39:41 -07:00
process.md doc: fixed a typo in process.md 2019-11-30 18:07:41 +01:00
punycode.md
querystring.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
readline.md doc: include line/cursor in readline documentation 2019-12-07 23:06:25 +01:00
repl.md doc: revise REPL uncaught exception text 2019-12-01 21:59:51 -08:00
report.md doc: remove dashes 2019-10-26 08:39:41 -07:00
stream.md doc: add note of caution about non-conforming streams 2019-11-25 14:35:06 -08:00
string_decoder.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
synopsis.md doc: move Usage and Example to same header level 2019-07-09 19:45:20 -07:00
timers.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00
tls.md tls: expose IETF name for current cipher suite 2019-12-03 23:28:38 +01:00
tracing.md doc: remove dashes 2019-10-26 08:39:41 -07:00
tty.md doc: remove dashes 2019-10-26 08:39:41 -07:00
url.md doc: add entry to url.parse() changes metadata 2019-11-15 15:47:01 +01:00
util.md util: add more predefined color codes to inspect.colors 2019-12-07 00:31:07 +01:00
v8.md doc: remove "this API is unstable" note for v8 serdes API 2019-11-28 00:18:41 +01:00
vm.md esm: unflag --experimental-modules 2019-11-12 14:04:55 -08:00
wasi.md 2019-12-03, Version 13.3.0 (Current) 2019-12-03 22:57:31 +01:00
worker_threads.md worker: add argv constructor option 2019-12-03 23:44:10 +01:00
zlib.md doc: escape brackets not used as markdown reference links 2019-10-10 22:15:58 -07:00