0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
nodejs/doc/api/repl.markdown

104 lines
3.2 KiB
Markdown
Raw Normal View History

2010-10-28 14:18:16 +02:00
## REPL
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and easily
includable in other programs. REPL provides a way to interactively run
JavaScript and see the results. It can be used for debugging, testing, or
just trying things out.
By executing `node` without any arguments from the command-line you will be
dropped into the REPL. It has simplistic emacs line-editing.
mjr:~$ node
Type '.help' for options.
> a = [ 1, 2, 3];
2010-10-28 14:18:16 +02:00
[ 1, 2, 3 ]
> a.forEach(function (v) {
2010-10-28 14:18:16 +02:00
... console.log(v);
... });
1
2
3
For advanced line-editors, start node with the environmental variable `NODE_NO_READLINE=1`.
This will start the REPL in canonical terminal settings which will allow you to use with `rlwrap`.
For example, you could add this to your bashrc file:
alias node="env NODE_NO_READLINE=1 rlwrap node"
2011-01-02 06:54:46 +01:00
### repl.start(prompt='> ', stream=process.stdin)
2010-10-28 14:18:16 +02:00
Starts a REPL with `prompt` as the prompt and `stream` for all I/O. `prompt`
is optional and defaults to `> `. `stream` is optional and defaults to
2011-01-02 06:54:46 +01:00
`process.stdin`.
2010-10-28 14:18:16 +02:00
Multiple REPLs may be started against the same running instance of node. Each
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;
repl.start("node via stdin> ");
net.createServer(function (socket) {
connections += 1;
repl.start("node via Unix socket> ", socket);
}).listen("/tmp/node-repl-sock");
net.createServer(function (socket) {
connections += 1;
repl.start("node via TCP socket> ", socket);
}).listen(5001);
Running this program from the command line will start a REPL on stdin. Other
REPL clients may connect through the Unix socket or TCP socket. `telnet` is useful
for connecting to TCP sockets, and `socat` can be used to connect to both Unix and
TCP sockets.
By starting a REPL from a Unix socket-based server instead of stdin, you can
2010-10-28 14:18:16 +02:00
connect to a long-running node process without restarting it.
### REPL Features
Inside the REPL, Control+D will exit. Multi-line expressions can be input.
The special variable `_` (underscore) contains the result of the last expression.
> [ "a", "b", "c" ]
2010-10-28 14:18:16 +02:00
[ 'a', 'b', 'c' ]
> _.length
2010-10-28 14:18:16 +02:00
3
> _ += 1
2010-10-28 14:18:16 +02:00
4
The REPL provides access to any variables in the global scope. You can expose a variable
2010-10-28 14:18:16 +02:00
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";
repl.start().context.m = msg;
Things in the `context` object appear as local within the REPL:
mjr:~$ node repl_test.js
> m
2010-10-28 14:18:16 +02:00
'message'
There are a few special REPL commands:
- `.break` - While inputting a multi-line expression, sometimes you get lost
or just don't care about completing it. `.break` will start over.
2010-10-28 14:18:16 +02:00
- `.clear` - Resets the `context` object to an empty object and clears any multi-line expression.
- `.exit` - Close the I/O stream, which will cause the REPL to exit.
- `.help` - Show this list of special commands.