How to unref readline?

Is your feature request related to a problem? Please describe.

const readline = require('readline');

const input = readline.createInterface({
	input: process.stdin
});

The code above just hangs.

Describe the solution you'd like

const readline = require('readline');

const input = readline.createInterface({
	input: process.stdin
});

+input.unref();

Describe alternatives you've considered

None yet.

Solved via process.stdin.unref();

Although I think it would be nice to add this to docs, so I'll reopen.

@szmarczak

@szmarczak I think instead of hanging, the program is waiting for the end of stdin.
If you start logging what the program reads like the docs say, you will see that it comes to an end after the input is over:

const readline = require('readline');

const input = readline.createInterface({
    input: process.stdin
});

input.on('line', (line) => {
    console.log(line);
})

Here is the log of a run:

❯ time echo 'here is a line'|node index
here is a line
echo 'here is a line'  0.00s user 0.00s system 33% cpu 0.002 total
node index  0.07s user 0.02s system 63% cpu 0.140 total

@szmarczak

@szmarczak if still need to address this issue and add this functionality to the doc I would like to take this and open a PR.
Just want to make sure what is being asked... in this API doc I need to add an example as you described? can you maybe give me any advice about in which section do you think that it would be wise to add this example to?

At the end of readline.createInterface(options) section

Documentation for how to unref readline

I have added the example. Please let me know if it needs an update.

@aduh95

@aduh95 I see your review on the referenced PR, I can open a new PR addressing your comments there. Can I be assigned to this?

@AnupamaP

@AnupamaP By all means, go for it :)

@aduh95

@aduh95 thanks, would appreciate your thoughts on my PR :)

doc: document how to unref stdin when using readline.Interface

Navigation Menu

Repository navigation

How to unref readline? #36154

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

How to unref readline? #36154

Description

Activity

szmarczak commented on Nov 17, 2020

szmarczak commented on Nov 17, 2020

RaisinTen commented on Nov 20, 2020

danielglazer commented on Nov 20, 2020

szmarczak commented on Nov 20, 2020

vbinithyanandamv commented on Dec 9, 2020

AnupamaP commented on Mar 31, 2021

aduh95 commented on Mar 31, 2021

AnupamaP commented on Apr 1, 2021

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions