@fav/text.pad

Pads characters on the left and right sides of a source string to center it.

"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

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/ directory manually.

Usage

For Node.js, when installing @fav/text.pad from npm:

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

For Web browsers:

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

API

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

Pads padding on left and right sides of source to center it.

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 types.

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:

| Type | Description | |:------:|:-------------------| } string | The padded string. |

Checked

Node.js (4〜12)

| Platform | 11 | 12 | |:---------:|:------:|:------:| | macOS |◯|◯| | Windows10 |◯|◯| | Linux |◯|◯|

| 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-2019 Takayuki Sato

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