readtastic.js

readtastic

readtastic is a fast, minimalistic, lightweight, promise-based tool for interacting with input streams line by line.

Installation

To get started with readtastic, simply run the following command in your terminal:

$ npm i readtastic

Getting started

First, require this library to your project as follows:

const readtastic = require("readtastic");

If it’s an ES Module then import it to your project as follows:

import readtastic from "readtastic";

Note

New to Promises?

If you’re not familiar with promises, check out the MDN documentation to learn more.

Built on Top of Node.js readline library

Under the hood, readtastic leverages the built-in readline library in Node.js, ensuring a seamless and efficient experience.

Api usage

Once you’ve imported readtastic into your project, you’re ready to start working using readtastic!

Below is a simple example demonstrating the usage:

try {
    // Creates a new interface
    // It's similar to the Node's built-in readline module
    readtastic.parse_interface({
        input: process.stdin,
        output: process.stdout
    });

    // Prompt the user
    // Use await since it's an async function
    const phrase = await readtastic.prompt("What do you think of readtastic?\n");

    // Log out the a answer of the prompt.
    // In this case it's 'phrase'.
    console.log(`You said: ${phrase}`);

    // Simple thank you note at last.
    console.log(`Thank you for your valuable feedback!`);
} catch (error) {
    // Handling the error.
    console.error(error);
}

LICENSE

readtastic is released under the MIT License.

View the full license terms here.

Bugs & Issues

Found a bug or want a new feature?

Report issues and request features on the readtastic issue tracker.

Thanks for reading!

Have a great day ahead :D

This site is open source. Improve this page.