README
Right Pad
Right pad a string.
Installation
npm install @stdlib/string-right-pad
Usage
var rpad = require( '@stdlib/string-right-pad' );
rpad( str, len[, pad] )
Right pads a string such that the padded string has a length of at least len.
var str = rpad( 'a', 5 );
// 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 = rpad( 'beep', 10, 'p' );
// returns 'beeppppppp'
str = rpad( 'beep', 12, 'boop' );
// returns 'beepboopboop'
Notes
An output
stringis not guaranteed to have a length of exactlylen, but to have alengthof at leastlen. To generate a paddedstringhaving alengthequal tolenvar str = rpad( 'beep', 10, 'boop' ); // returns 'beepboopboop' => length 12 str = str.substring( 0, 10 ); // returns 'beepboopbo' => length 10
Examples
var round = require( '@stdlib/math-base-special-round' );
var randu = require( '@stdlib/random-base-randu' );
var rpad = require( '@stdlib/string-right-pad' );
var str = 'beep';
var n;
var i;
for ( i = 0; i < 100; i++ ) {
n = round( randu()*10.0 ) + str.length;
console.log( rpad( str, n, 'p' ) );
}
CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-right-pad
Usage
Usage: rpad [options] [<string>] --len=<length>
Options:
-h, --help Print this message.
-V, --version Print the package version.
--len length Minimum string length.
--pad str String used to pad. Default: ' '.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
Notes
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n