function createInterface
Overload 1
#createInterface(): InterfaceThe readlinePromises.createInterface() method creates a new readlinePromises.Interface instance.
import readlinePromises from 'node:readline/promises';
const rl = readlinePromises.createInterface({
input: process.stdin,
output: process.stdout,
});
Once the readlinePromises.Interface instance is created, the most common case
is to listen for the 'line' event:
rl.on('line', (line) => {
console.log(`Received: ${line}`);
});
If terminal is true for this instance then the output stream will get
the best compatibility if it defines an output.columns property and emits
a 'resize' event on the output if or when the columns ever change
(process.stdout does this automatically when it is a TTY).
Parameters #
Return Type #
Overload 2
#createInterface(options: ReadLineOptions): InterfaceParameters #
#options: ReadLineOptions