Neurotic Pumpkin Murderer

    @fav/text.pad-right

    1.0.2 • Public • Published

    @fav/text.pad-right NPM MIT License Build Status Build Status Coverage status

    Pads characters on right sides of a source string.

    "fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

    Install

    To install from npm:

    $ npm install --save @fav/text.pad-right

    NOTE: npm < 2.7.0 does not support scoped package, but even old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/text.pad-right/ directory manually.

    Usage

    For Node.js:

    var padRight = require('@fav/text.pad-right');
    padRight('abc', 8); // => 'abc     '
    padRight('abc', 8, '_-'); // => 'abc_-_-_'

    For Web browsers:

    <script src="fav.text.pad-right.min.js"></script>
    <script>
    var padRight = fav.text.padRight;
    padRight('abc', 8); // => 'abc     '
    </script>

    API

    padRight(source, [, length ] [, padding ]) : string

    Pads padding on right side of source.

    If length is less than the length of source, return source with no padding.

    If padding is not specified, this function use a white space ('\u0020') as a padding.

    NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data type.

    NOTE: This function is different from String#padEnd at the point that this function uses a white space ('\u0020') as padding when specified null or an empty string to padding.

    Parameter:

    Parameter Type Description
    source string The source string.
    length number The length of the result text. (Optional, and source.length in default.)
    padding string The padding characters. (Optional, and ' ' in default.)

    Return:

    The padded string.

    Type: string

    Checked

    Node.js (4〜)

    Platform 4 5 6 7 8 9 10
    macOS
    Windows10
    Linux

    io.js (1〜3)

    Platform 1 2 3
    macOS
    Windows10
    Linux

    Node.js (〜0.12)

    Platform 0.8 0.9 0.10 0.11 0.12
    macOS
    Windows10
    Linux

    Web browsers

    Platform Chrome Firefox Vivaldi Safari Edge IE11
    macOS -- --
    Windows10 --
    Linux -- -- --

    License

    Copyright (C) 2017-2018 Takayuki Sato

    This program is free software under MIT License. See the file LICENSE in this distribution for more details.

    Install

    npm i @fav/text.pad-right

    DownloadsWeekly Downloads

    3

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    13.7 kB

    Total Files

    8

    Last publish

    Collaborators

    • sttk