Commit 3912b5c
doc: adds usage of readline line-by-line parsing
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.
PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>1 parent 787c5d9 commit 3912b5c
1 file changed
Lines changed: 16 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -232,6 +232,22 @@ line interface: | |||
| 232 | 232 | process.exit(0); | |
| 233 | 233 | }); | |
| 234 | 234 | ||
| 235 | + ## Example: Read File Stream Line-by-Line | ||
| 236 | + | ||
| 237 | + A common case for `readline`'s `input` option is to pass a filesystem readable | ||
| 238 | + stream to it. This is how one could craft line-by-line parsing of a file: | ||
| 239 | + | ||
| 240 | + const readline = require('readline'); | ||
| 241 | + const fs = require('fs'); | ||
| 242 | + | ||
| 243 | + const rl = readline.createInterface({ | ||
| 244 | + input: fs.createReadStream('sample.txt') | ||
| 245 | + }); | ||
| 246 | + | ||
| 247 | + rl.on('line', function (line) { | ||
| 248 | + console.log('Line from file:', line); | ||
| 249 | + }); | ||
| 250 | + | ||
| 235 | 251 | ## readline.clearLine(stream, dir) | |
| 236 | 252 | ||
| 237 | 253 | Clears current line of given TTY stream in a specified direction. | |
0 commit comments