@stdlib/string-right-pad NPM

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 string is not guaranteed to have a length of exactly len, but to have a length of at least len. To generate a padded string having a length equal to len
```
var 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' ) );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.