Skip to content
This repository has been archived by the owner on Aug 31, 2018. It is now read-only.

Commit

Permalink
doc: clarify using crlfDelay with fs streams
Browse files Browse the repository at this point in the history
PR-URL: nodejs/node#16259
Fixes: nodejs/node#16077
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
  • Loading branch information
vsemozhetbyt authored and addaleax committed Oct 26, 2017
1 parent cc4f715 commit 14ddaa2
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,8 @@ changes:
end-of-line input. Default to `100` milliseconds.
`crlfDelay` will be coerced to a number no less than `100`. It can be set to
`Infinity`, in which case `\r` followed by `\n` will always be considered a
single newline.
single newline (which may be reasonable for [reading files][] with `\r\n`
line delimiter).
* `removeHistoryDuplicates` {boolean} If `true`, when a new input line added
to the history list duplicates an older one, this removes the older line
from the list. Defaults to `false`.
Expand Down Expand Up @@ -532,7 +533,8 @@ const readline = require('readline');
const fs = require('fs');

const rl = readline.createInterface({
input: fs.createReadStream('sample.txt')
input: fs.createReadStream('sample.txt'),
crlfDelay: Infinity
});

rl.on('line', (line) => {
Expand All @@ -547,3 +549,4 @@ rl.on('line', (line) => {
[Readable]: stream.html#stream_readable_streams
[TTY]: tty.html
[Writable]: stream.html#stream_writable_streams
[reading files]: #readline_example_read_file_stream_line_by_line

0 comments on commit 14ddaa2

Please sign in to comment.