<commit_before>Right Pad
===
> Right pad a string.

<!-- <usage> -->
## Usage

``` javascript
var rpad = require( '@stdlib/utils/right-pad-string' );
```

#### rpad( str, len[, pad] )

Right pads a `string` such that the padded `string` has a `length` of __at least__ `len`.


``` javascript
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.

``` javascript
var str = rpad( 'beep', 10, 'p' );
// returns 'beeppppppp'

str = rpad( 'beep', 12, 'boop' );
// returns 'beepboopboop'
```
<!-- </usage> -->

<!-- <notes> -->
## 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`

    ``` javascript
    var str = rpad( 'beep', 10, 'boop' );
    // returns 'beepboopboop' => length 12

    str = str.substring( 0, 10 );
    // returns 'beepboopbo' => length 10
    ```

<!-- </notes> -->

<!-- <examples> -->
## Examples

``` javascript
var round = require( '@stdlib/math/base/special/round' );
var randu = require( '@stdlib/math/base/random/randu' );
var rpad = require( '@stdlib/utils/right-pad-string' );

var str = 'beep';
var n;
var i;

for ( i = 0; i < 100; i++ ) {
    n = round( randu()*10 ) + str.length;
    console.log( rpad( str, n, 'p' ) );
}
```
<!-- </examples> -->

<!-- <cli> -->
---
## CLI

<!-- <usage> -->
### Usage

``` bash
Usage: rpad [options] str --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: ' '.
```
<!-- </usage> -->

<!-- <examples> -->
### Examples

``` bash
$ rpad beep --len 10 --pad p
# => beeppppppp
```
<!-- </examples> -->
<!-- </cli> -->

<!-- <links> -->
<!-- </links> --><commit_msg>Add linebreaks to conform with commonmark standard<commit_after># Right Pad

> Right pad a string.

<!-- <usage> -->

## Usage

``` javascript
var rpad = require( '@stdlib/utils/right-pad-string' );
```

#### rpad( str, len[, pad] )

Right pads a `string` such that the padded `string` has a `length` of __at least__ `len`.


``` javascript
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.

``` javascript
var str = rpad( 'beep', 10, 'p' );
// returns 'beeppppppp'

str = rpad( 'beep', 12, 'boop' );
// returns 'beepboopboop'
```

<!-- </usage> -->

<!-- <notes> -->

## 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`

    ``` javascript
    var str = rpad( 'beep', 10, 'boop' );
    // returns 'beepboopboop' => length 12

    str = str.substring( 0, 10 );
    // returns 'beepboopbo' => length 10
    ```

<!-- </notes> -->

<!-- <examples> -->

## Examples

``` javascript
var round = require( '@stdlib/math/base/special/round' );
var randu = require( '@stdlib/math/base/random/randu' );
var rpad = require( '@stdlib/utils/right-pad-string' );

var str = 'beep';
var n;
var i;

for ( i = 0; i < 100; i++ ) {
    n = round( randu()*10 ) + str.length;
    console.log( rpad( str, n, 'p' ) );
}
```

<!-- </examples> -->

<!-- <cli> -->

---
## CLI

<!-- <usage> -->

### Usage

``` bash
Usage: rpad [options] str --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: ' '.
```

<!-- </usage> -->

<!-- <examples> -->

### Examples

``` bash
$ rpad beep --len 10 --pad p
# => beeppppppp
```

<!-- </examples> -->

<!-- </cli> -->

<!-- <links> -->

<!-- </links> -->
{'fraction_non_alphanumeric': 0.20977295162882528, 'fraction_numerical': 0.01085883514313919, 'mean_word_length': 2.4464285714285716, 'pattern_counts': {'":': 0, '<': 61, '<?xml version=': 0, '>': 67, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 4, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6717415', 'n_tokens_mistral': 1510, 'n_tokens_neox': 1377, 'n_words': 455}