cli-update

    3.2.7 • Public • Published

    cli-update

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

    Buy Me A Coffee

    A library to update stdout output.

    ☁️ Installation

    # Using npm 
    npm install --save cli-update
     
    # Using yarn 
    yarn add cli-update

    📋 Example

    // Dependencies
    var CliUpdate = require("cli-update")
      , CliBox = require("cli-box")
      , Couleurs = require("couleurs")()
      , Figlet = require("figlet")
      ;
     
    // http://stackoverflow.com/a/16426519/1420197
    function getDateTime() {
     
        var date = new Date();
     
        var hour = date.getHours();
        hour = (hour < 10 ? "0" : "") + hour;
     
        var min  = date.getMinutes();
        min = (min < 10 ? "0" : "") + min;
     
        var sec  = date.getSeconds();
        sec = (sec < 10 ? "0" : "") + sec;
     
        return hour + " : " + min + " : " + sec;
    }
     
    // Render time in a fancy format
    setInterval(function () {
        Figlet(getDateTime(), function(err, data) {
            data = data.split("\n").map(function (c) { return Couleurs.bg(c, "#c0392b") + "\u001b[45m"; }).join("\n");
            CliUpdate.render(
                CliBox({
                    fullscreen: true
                  , marks: {}
                }, data).split("\n").map(function (c) {
                    return Couleurs.bg(c, "#2980b9");
                }).join("\n")
            );
        });
    }, 1000);

    ❓ 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

    render(output, pushHistory, data, emitChanged)

    Render the current output.

    Params

    • String output: The output that should be printed in stdout.
    • Boolean pushHistory: Push or not push the output in history (default: true).
    • Object data:
    • Boolean emitChanged: Call or not call the changed handler (deafult: true).

    Return

    • Object The CliUpdate object.

    back()

    Go to the previous output in the history.

    Return

    • Object The CliUpdate object.

    next()

    Go to the next output in the history.

    Return

    • Object The CliUpdate object.

    😋 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! ❤️

    💫 Where is this library used?

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

    • cli-frames
    • cli-confeti
    • cli-snow
    • nuvi
    • vivah
    • ascii-github
    • gafas
    • 3abn
    • cli-github
    • cli-confetti
    • artstack-downloader

    📜 License

    MIT © Ionică Bizău

    Install

    npm i cli-update

    DownloadsWeekly Downloads

    259

    Version

    3.2.7

    License

    MIT

    Unpacked Size

    11.4 kB

    Total Files

    4

    Last publish

    Collaborators

    • ionicabizau