8392e8cdfb
doc: improve readLine.pause()
...
The docs for readLine.pause are misleading. I seriously spent hours on this. If
it isn't a bug, at least it should be well documented.
Someone else stumbled on this too:
http://stackoverflow.com/questions/21341050/pausing-readline-in-node-js
Reviewed-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com>
2014-10-06 19:24:29 -05:00
862cc28183
readline: should not require an output stream.
...
Passing null as the output stream to readline.Interface()'s constructor
is now supported. Any output written by readline is just discarded. It
makes it easier to use readline just as a line parser.
Fixes: https://github.com/joyent/node/issues/4408
Reviewed-by: Trevor Norris <trev.norris@gmail.com>
2014-10-01 15:00:02 -07:00
51b6b6844e
doc: fix brackets for optional parameters
...
Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:
fs.write(fd, data[, position[, encoding]], callback)
This simply fixes all uses of bracket notation in documentation.
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Fedor Indutny <fedor@indutny.com>
2014-09-25 11:26:15 -07:00
c37e1b7c4b
Merge remote-tracking branch 'upstream/v0.10'
...
Conflicts:
src/node_crypto.cc
test/simple/test-crypto.js
2014-01-27 11:02:59 -08:00
0ec3770767
doc: readline document TTY utils
...
fix #6933
2014-01-25 12:10:44 -08:00
c1b1f31203
Merge remote-tracking branch 'upstream/v0.10'
...
Conflicts:
AUTHORS
ChangeLog
deps/uv/AUTHORS
deps/uv/ChangeLog
deps/uv/src/unix/process.c
deps/uv/src/version.c
lib/net.js
node.gyp
src/node_version.h
2014-01-24 19:13:50 -08:00
9975ff603b
doc: fix typo in readline
2014-01-24 18:56:46 +04:00
94284e7d2e
readline: handle wide characters properly
...
Handle wide characters (such as あ, 谢, 고) as two column wide to make
cursor move properly.
Closes #555 .
Closes #4994 .
2013-03-15 16:18:30 -10:00
34f05a3195
docs: update var names in readline docs to be consistent
...
Closes #3201 .
2012-05-06 11:23:09 -07:00
c9e6d3696c
doc: typo fixes
2012-05-01 02:25:08 +02:00
525253d50e
doc: add args for rl.write and rl.prompt
2012-04-21 05:31:47 +02:00
d2860a6c7d
doc: make readline example filter shorter
2012-04-18 15:21:56 +02:00
20143b359c
doc: add some headers to make it more legible
2012-04-18 15:21:51 +02:00
e28eb6de30
doc: update the `readline` docs for the "close" event behavior
2012-04-17 11:53:50 -07:00
86bd9b6e70
doc: change `in` to `input` in the readline docs
...
Also compacting some long lines.
2012-04-17 11:53:49 -07:00
26b6da134f
doc: change stability index of tty and readline to Unstable
2012-03-28 20:13:28 -07:00
f41901cdf6
repl: make ^D emit an 'end' event on the readline instance
...
Also emit 'exit' on the repl when 'end' is emitted on the readline.
Fixes `node debug test/fixtures/breakpoints.js` when ^D is pressed.
2012-03-27 13:54:49 -07:00
aad12d0b26
readline: migrate ansi/vt100 logic from tty to readline
...
The overall goal here is to make readline more interoperable with other node
Streams like say a net.Socket instance, in "terminal" mode.
See #2922 for all the details.
Closes #2922 .
2012-03-26 15:21:25 -07:00
943c396b86
Fix merge conflict in doc/api/readline.markdown
2012-03-13 09:16:48 -07:00
1d5b6f26fe
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
...
Conflicts:
ChangeLog
Makefile
deps/npm/AUTHORS
deps/npm/html/api/bin.html
deps/npm/html/api/bugs.html
deps/npm/html/api/commands.html
deps/npm/html/api/config.html
deps/npm/html/api/deprecate.html
deps/npm/html/api/docs.html
deps/npm/html/api/edit.html
deps/npm/html/api/explore.html
deps/npm/html/api/help-search.html
deps/npm/html/api/init.html
deps/npm/html/api/install.html
deps/npm/html/api/link.html
deps/npm/html/api/load.html
deps/npm/html/api/ls.html
deps/npm/html/api/npm.html
deps/npm/html/api/outdated.html
deps/npm/html/api/owner.html
deps/npm/html/api/pack.html
deps/npm/html/api/prefix.html
deps/npm/html/api/prune.html
deps/npm/html/api/publish.html
deps/npm/html/api/rebuild.html
deps/npm/html/api/restart.html
deps/npm/html/api/root.html
deps/npm/html/api/run-script.html
deps/npm/html/api/search.html
deps/npm/html/api/shrinkwrap.html
deps/npm/html/api/start.html
deps/npm/html/api/stop.html
deps/npm/html/api/submodule.html
deps/npm/html/api/tag.html
deps/npm/html/api/test.html
deps/npm/html/api/uninstall.html
deps/npm/html/api/unpublish.html
deps/npm/html/api/update.html
deps/npm/html/api/version.html
deps/npm/html/api/view.html
deps/npm/html/api/whoami.html
deps/npm/html/doc/README.html
deps/npm/html/doc/adduser.html
deps/npm/html/doc/bin.html
deps/npm/html/doc/bugs.html
deps/npm/html/doc/build.html
deps/npm/html/doc/bundle.html
deps/npm/html/doc/cache.html
deps/npm/html/doc/changelog.html
deps/npm/html/doc/coding-style.html
deps/npm/html/doc/completion.html
deps/npm/html/doc/config.html
deps/npm/html/doc/deprecate.html
deps/npm/html/doc/developers.html
deps/npm/html/doc/disputes.html
deps/npm/html/doc/docs.html
deps/npm/html/doc/edit.html
deps/npm/html/doc/explore.html
deps/npm/html/doc/faq.html
deps/npm/html/doc/folders.html
deps/npm/html/doc/help-search.html
deps/npm/html/doc/help.html
deps/npm/html/doc/index.html
deps/npm/html/doc/init.html
deps/npm/html/doc/install.html
deps/npm/html/doc/json.html
deps/npm/html/doc/link.html
deps/npm/html/doc/list.html
deps/npm/html/doc/npm.html
deps/npm/html/doc/outdated.html
deps/npm/html/doc/owner.html
deps/npm/html/doc/pack.html
deps/npm/html/doc/prefix.html
deps/npm/html/doc/prune.html
deps/npm/html/doc/publish.html
deps/npm/html/doc/rebuild.html
deps/npm/html/doc/registry.html
deps/npm/html/doc/removing-npm.html
deps/npm/html/doc/restart.html
deps/npm/html/doc/root.html
deps/npm/html/doc/run-script.html
deps/npm/html/doc/scripts.html
deps/npm/html/doc/search.html
deps/npm/html/doc/semver.html
deps/npm/html/doc/shrinkwrap.html
deps/npm/html/doc/star.html
deps/npm/html/doc/start.html
deps/npm/html/doc/stop.html
deps/npm/html/doc/submodule.html
deps/npm/html/doc/tag.html
deps/npm/html/doc/test.html
deps/npm/html/doc/uninstall.html
deps/npm/html/doc/unpublish.html
deps/npm/html/doc/update.html
deps/npm/html/doc/version.html
deps/npm/html/doc/view.html
deps/npm/html/doc/whoami.html
deps/npm/lib/install.js
deps/npm/lib/ls.js
deps/npm/man/man1/npm.1
deps/npm/man/man1/shrinkwrap.1
deps/npm/man/man3/npm.3
deps/npm/man/man3/shrinkwrap.3
deps/npm/node_modules/request/main.js
deps/npm/node_modules/request/package.json
deps/npm/package.json
deps/uv/src/unix/core.c
deps/v8/src/conversions-inl.h
deps/v8/src/elements.cc
deps/v8/src/version.cc
doc/about/index.html
doc/api/assert.markdown
doc/api/child_process.markdown
doc/api/cluster.markdown
doc/api/crypto.markdown
doc/api/debugger.markdown
doc/api/dgram.markdown
doc/api/dns.markdown
doc/api/documentation.markdown
doc/api/events.markdown
doc/api/fs.markdown
doc/api/globals.markdown
doc/api/http.markdown
doc/api/https.markdown
doc/api/modules.markdown
doc/api/net.markdown
doc/api/os.markdown
doc/api/path.markdown
doc/api/process.markdown
doc/api/querystring.markdown
doc/api/readline.markdown
doc/api/stdio.markdown
doc/api/stream.markdown
doc/api/timers.markdown
doc/api/tls.markdown
doc/api/tty.markdown
doc/api/url.markdown
doc/api/util.markdown
doc/api/vm.markdown
doc/api/zlib.markdown
doc/api_assets/style.css
doc/community/index.html
doc/index.html
doc/logos/index.html
doc/template.html
src/node_version.h
tools/doc/html.js
tools/gyp/test/mac/app-bundle/empty.c
2012-03-03 23:38:52 -08:00
2d44dcc8be
doc: Add stability indicators to documentation
2012-03-03 17:03:52 -08:00
3b6c1d74c7
doc refactor: readline
2012-02-29 16:04:53 -08:00
728386bfb2
doc refactor: readline
2012-02-27 11:14:35 -08:00
fd61bfc731
readline: ^Z (SIGSTP) handling
...
Bugfix and update.
- Fixed bug where Node's REPL wouldn't continue when returning from ^Z
(SIGTSTP)
- Removed old readline callback
Readline API update with docs.
- ^Z (SIGTSTP) is now bypassed on Windows systems.
- SIGCONT is now bypassed on Windows systems.
- Docs updated to reflect above.
2012-02-22 16:07:23 -08:00
ce485791db
Readline proposal and bugfixes. Related: #2737 #2756
...
- Removed extra newline from .question(); Users can input a
newline if it they require it.
- Removed .close() due to it only emulating closing, causing a bug where
readline is left open to trigger events such as .on('line', ...').
- Removed ._attemptClose()
- .pause() now triggers event .on('pause', ...)
- .resume() now triggers event .on('resume', ...)
- CTRL-C (SIGINT) in readline will now default to .pause() if no SIGINT event
is present.
- CTRL-D (delete right) will also default to .pause() if there is nothing to
delete (signaling the end of the file).
- Added new event `SIGTSTP`
- Added new event `SIGCONT`
- Added `resume` to `write` to resume the stream if paused.
- Docs updated.
- Updated repl.js
2012-02-16 12:12:03 +06:00
fc61134b1a
doc: fix links
...
Changes:
* 'http://github.com ' => 'https://github.com '
* 'https://github.com/ry/node ' => 'https://github.com/joyent/node '
* 'https://github.com/ry/http-parser ' =>
'https://github.com/joyent/http-parser '
* old issue links
* wiki link
2011-11-01 22:26:52 +01:00
178e2ce65f
docs: improve addons, readline, repl documentation
2011-10-11 21:44:09 +02:00
3bf20e43cf
Fixes #1635 . Fixed typo
2011-09-02 13:01:05 -07:00
d5c95f02af
docs: rename readline.md to readline.markdown
2011-08-08 00:56:04 +02:00
934c82b8b8
Partially documented the readline module.
2011-04-21 11:42:40 -07:00
e190c9616e
Splitting documentation
2010-10-28 14:59:15 -07:00
Victor Widell
Julien Gilli
Trevor Norris
Timothy J Fontaine
Fedor Indutny
Scott González
Nao Iizuka
James Koval
Kyle Robinson Young
Josh W
Nathan Rajlich
Shigeki Ohtsu
isaacs
Colton Baker
Maciej Małecki
Michael Jackson
Ben Noordhuis
Nebu
Micheil Smith