Skip to content

doc updates from joyent/node #2378

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

Closed
jasnell wants to merge 20 commits into from
Closed

doc updates from joyent/node #2378

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
66a0af2
doc: Clarify the module.parent is set once
jasnell Aug 14, 2015
fcbd2bc
doc: correct grammar in cluster.markdown
jasnell Aug 14, 2015
81e4274
doc: code style cleanups in repl.markdown
jasnell Aug 14, 2015
3803291
doc: small clarifications to modules.markdown
jasnell Aug 14, 2015
3d5056f
doc: update path.extname documentation
jasnell Aug 14, 2015
a90e5fe
doc: improve working in stream.markdown
jasnell Aug 14, 2015
0173b90
doc: clarification on the 'close' event
jasnell Aug 14, 2015
e37f1c8
doc: update description of fs.exists in fs.markdown
jasnell Aug 14, 2015
55c41df
doc: fixed typo in net.markdown (missing comma)
jasnell Aug 14, 2015
87bdb0a
doc: small typo in domain.markdown
jasnell Aug 14, 2015
1db5495
doc: update parameter name in net.markdown
jasnell Aug 14, 2015
8e44a54
doc: fix minor types and grammar in fs docs
jasnell Aug 14, 2015
bc9cfd6
doc: port is optional for socket.bind()
jasnell Aug 14, 2015
60ae572
doc: fixed worker.id type
jasnell Aug 14, 2015
a1a09ac
doc: update tense in child_process.markdown
jasnell Aug 14, 2015
9edad0e
doc: remove 'dudes' from documentation
jasnell Aug 14, 2015
232a8b7
doc: remove repeated statement in globals.markdown
jasnell Aug 14, 2015
161fe34
doc: minor grammatical update
jasnell Aug 14, 2015
334d09d
doc: minor grammatical update in crypto.markdown
jasnell Aug 14, 2015
03206cb
doc: minor additional corrections and improvements
jasnell Aug 22, 2015
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
Prev Previous commit
Next Next commit
doc: code style cleanups in repl.markdown 
per: nodejs/node-v0.x-archive#8778

originally submitted by @reggi
  • Loading branch information
@jasnell
jasnell committed Aug 26, 2015
commit 81e4274136eedaac69fbe8810c2b76cfda607914
25 changes: 12 additions & 13 deletions doc/api/repl.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,32 +117,31 @@ will share the same global object but will have unique I/O.

Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:

var net = require("net"),
repl = require("repl");

connections = 0;
var net = require('net'),
repl = require('repl'),
connections = 0;

repl.start({
prompt: "Node.js via stdin> ",
prompt: 'Node.js via stdin> ',
input: process.stdin,
output: process.stdout
});

net.createServer(function (socket) {
connections += 1;
repl.start({
prompt: "Node.js via Unix socket> ",
prompt: 'Node.js via Unix socket> ',
input: socket,
output: socket
}).on('exit', function() {
socket.end();
})
}).listen("/tmp/node-repl-sock");
}).listen('/tmp/node-repl-sock');

net.createServer(function (socket) {
connections += 1;
repl.start({
prompt: "Node.js via TCP socket> ",
prompt: 'Node.js via TCP socket> ',
input: socket,
output: socket
}).on('exit', function() {
Expand Down Expand Up @@ -191,7 +190,7 @@ be emitted.
Example of listening for `reset`:

// Extend the initial repl context.
r = repl.start({ options ... });
var r = repl.start({ options ... });
someExtension.extend(r.context);

// When a new context is created extend it as well.
Expand All @@ -213,7 +212,7 @@ accessing `fs` will `require()` the `fs` module as `global.fs`.

The special variable `_` (underscore) contains the result of the last expression.

> [ "a", "b", "c" ]
> [ 'a', 'b', 'c' ]
[ 'a', 'b', 'c' ]
> _.length
3
Expand All @@ -225,10 +224,10 @@ a variable to the REPL explicitly by assigning it to the `context` object
associated with each `REPLServer`. For example:

// repl_test.js
var repl = require("repl"),
msg = "message";
var repl = require('repl'),
msg = 'message';

repl.start("> ").context.m = msg;
repl.start('> ').context.m = msg;

Things in the `context` object appear as local within the REPL:

Expand Down