Neodymium Plated Magnet

    @wenbo/print-message

    1.0.0 • Public • Published

    print-message

    Build Status Coverage

    Downloads Downloads npm version License

    semantic-release Commitizen friendly dependencies dev dependencies

    NodeJS module for printing out beautiful messages in console.

    examples/simple.js

    Installation

    Install print-message module:

    npm install print-message

    Getting Started

    Require print-message module and call a function:

    var printMessage = require('print-message');
    
    printMessage(['Hello, everyone']);

    Options

    You can set your own options for border.

    var printMessage = require('print-message');
    
    printMessage([
        "You can set your own options for border",
        "Options below is default options"
    ], {
        border: true, // Enable border
        color: 'default', // Default text color from console
        borderColor: 'yellow', // Border color is yellow
        borderSymbol: '─', // Symbol that uses for border
        sideSymbol: '│', // Symbol that uses for side separators
        leftTopSymbol: '┌', // Symbol that uses for left top corner
        leftBottomSymbol: '└', // Symbol that uses for left bottom corner
        rightTopSymbol: '┐', // Symbol that uses for right top corner
        rightBottomSymbol: '┘', // Symbol that uses for right bottom corner
        marginTop: 0, // Margin before border is begins
        marginBottom: 0, // Margin after border is ends
        paddingTop: 0, // Padding after border begins
        paddingBottom: 0, // Padding before border ends
        printFn: process.stdout.write.bind(process.stdout) // Custom function for print generated message
    });

    Examples

    Print simple message

    var printMessage = require('print-message');
    
    printMessage([
        "Hello",
        "It's the huge world",
        "But width can be calculated automatically"
    ]);

    examples/simple.js

    Print message with custom options

    var printMessage = require('print-message');
    
    printMessage(['You can set your own options for border'], {
        border: true, // Enable border
        color: 'green', // Text color
        borderColor: 'blue', // Border color is blue
        borderSymbol: '│', // Symbol that uses for border
        sideSymbol: '│', // Symbol that uses for side separators
        leftTopSymbol: '└', // Symbol for left top corner
        leftBottomSymbol: '┌', // Symbol for left bottom corner
        rightTopSymbol: '┘', // Symbol for right top corner
        rightBottomSymbol: '┐', // Symbol for right bottom corner
        marginTop: 3, // Margin before border is begins
        marginBottom: 3, // Margin after border is end
        paddingTop: 2, // Padding top after border begins
        paddingBottom: 2, // Padding bottom before border ends
        printFn: function (message) {
            // Custom function that accepts generated message as argument and print it
            process.stdout.write(message);
        }
    });

    examples/options.js

    Print message without border

    var printMessage = require('print-message');
    
    printMessage([
        "This message will be without border",
        "But you still can set marginTop and marginBottom"
    ], {
        border: false,
        marginTop: 3,
        marginBottom: 3
    });

    examples/withoutBorder.js

    License

    The MIT License (MIT)

    Copyright (c) 2015 Eugene Obrezkov

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i @wenbo/print-message

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    18.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • chumahtung