Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

readline-responsive

jason55516ISC1.0.6

Responsive version of readline, pause() and resume() method work immediately.

readline, responsive, pause, resume, immediately, line

readme

Introduction

readline-responsive is responsive version of readline. pause() and resume() method work immediately.

Usage

const readlineResponsive = require("readline-responsive");

//@param : Readable stream or String(filePath)
var rl = readlineResponsive(fs.createReadStream(__dirname+"/foo.txt"));

rl.on("line", function (data) {
    //it pauses immediately
    rl.pause();

    //after some async task...
    asyncTask(function () {
        rl.resume();
    });
});

rl.on("resume", function () {
    console.log("resume");
});

rl.on("pause", function () {
    console.log("pause");
});

rl.on("close", function () {
    console.log("closed");
});

Methods

It works like nodeJS's readline.

var readlineResponsive = require("readline-responsive");
var rl = readlineResponsive(fs.createReadStream(__dirname+"/foo.txt"));

rl.pause();
rl.resume();
rl.close();

Events

It works like nodeJS's readline.

var readlineResponsive = require("readline-responsive");
var rl = readlineResponsive(fs.createReadStream(__dirname+"/foo.txt"));

rl.on("line", function (data) {
    console.log("line", data);
});

rl.on("resume", function () {
    console.log("resume");
});

rl.on("pause", function () {
    console.log("pause");
});

rl.on("close", function () {
    console.log("closed");
});