Left Pad
Left pad a string.
Installation
$ npm install utils-left-pad-string
Usage
var lpad = ;
lpad( str, len[, pad] )
Left pads a string
such that the padded string
has a length
of at least len
.
var str = ;// returns ' a'
By default, an input string
is padded with spaces
. To pad with a different character or sequence of characters, provide a pad
string.
var str = ;// returns 'bbbbbbbeep'str = ;// returns 'beepbeepboop'
Notes
-
An output
string
is not guaranteed to have a length of exactlylen
, but to have alength
of at leastlen
. To generate a paddedstring
having alength
equal tolen
var str = ;// returns 'beepbeepboop' => length 12str = str;// returns 'epbeepboop' => length 10
Examples
var round = ;var lpad = ;var str = 'beep';var n;var i;for i = 0; i < 100; i++n = + strlength;console;
To run the example code from the top-level application directory,
$ node ./examples/index.js
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g utils-left-pad-string
Usage
Usage: lpad [options] str --len lengthOptions:-h, --help Print this message.-V, --version Print the package version.--len length Minimum string length.--pad str String used to pad. Default: ' '.
Examples
$ lpad beep --len 10 --pad b# => bbbbbbbeep
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.