Notoriously Psychedelic Modules

    promptify

    2.0.1 • Public • Published

    promptify

    Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

    Buy Me A Coffee

    An easy-to-use prompt for Node.js.

    ☁️ Installation

    # Using npm 
    npm install --save promptify
     
    # Using yarn 
    yarn add promptify

    📋 Example

    const promptify = require("promptify");
     
    let name = promptify("Enter your name");
    console.log(`Hey, ${name}!`);
     
    let pass = promptify("Enter your password", {
        char: "*"
    });
    console.log(`You entered: ${pass}`);

    ❓ Get Help

    There are few ways to get help:

    1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
    2. For bug reports and feature requests, open issues. 🐛
    3. For direct and quick help, you can use Codementor. 🚀

    📝 Documentation

    Promptify(conf)

    Creates a new Promptify. In most of the cases, there will be one such instance per process.

    Params

    • Object conf: The Promptify config:

    Return

    • Promptify The Promptify instance.

    sync(message, defMsg, options)

    Synchronous version of the prompt.

    Params

    • String message: The message do display.
    • String defMsg: The default value.
    • Object options: An object containing the following fields:
      • char (String): The character to display when writing something. For example, if it's *, the text characters will be replaced with *.
      • delimiter (String): The delimiter between message and the value (default: ": ").

    Return

    • String The result.

    promptify()

    Prompt a message to the user. The arguments are passed to the sync method.

    😋 How to contribute

    Have an idea? Found a bug? See how to contribute.

    💖 Support my projects

    I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

    However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

    • Starring and sharing the projects you like 🚀

    • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

    • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

    • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

    • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

    Thanks! ❤️

    🍰 Thanks

    💫 Where is this library used?

    If you are using this library in one of your projects, add it in this list. ✨

    • tilda
    • cli-github
    • parrot-bot

    📜 License

    MIT © Ionică Bizău

    Install

    npm i promptify

    DownloadsWeekly Downloads

    3,937

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    14.8 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar