Skip to content

Commit

Permalink
Simple doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
dashxdr committed Jun 14, 2018
1 parent 939711e commit cd2ea86
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/module_linenoise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# linenoise module
User input from console (stdin/stdout). Useful for interactive commands with
editing and line history. It's a modified version of the esp-idf copy of
linenoise written by someone else (see the attribution in module_linenoise.c).

We need to poll to give it a chance to process user input. The poll function
will return a complete string once one has been typed.

## Example:

if(true) {
var linenoise = require('linenoise');
linenoise.setPrompt('test> ');
setInterval(function() {
var line = linenoise.poll();
if(line!==undefined) linenoise.print(line);
}, 20);
}

0 comments on commit cd2ea86

Please sign in to comment.