> For the complete documentation index, see [llms.txt](https://bryan-guner.gitbook.io/my-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bryan-guner.gitbook.io/my-docs/redux/repos/examples/real-world/node_modules/left-pad.md).

# left-pad

### left-pad

String left pad

[![Build Status](https://travis-ci.org/stevemao/left-pad.svg?branch=master)](https://travis-ci.org/stevemao/left-pad)

### Install

```bash
$ npm install left-pad
```

### Usage

```js
const leftPad = require('left-pad')

leftPad('foo', 5)
// => "  foo"

leftPad('foobar', 6)
// => "foobar"

leftPad(1, 2, '0')
// => "01"

leftPad(17, 5, 0)
// => "00017"
```

**NOTE:** The third argument should be a single `char`. However the module doesn't throw an error if you supply more than one `char`s. See [#28](https://github.com/stevemao/left-pad/pull/28).

**NOTE:** Characters having code points outside of [BMP plan](https://en.wikipedia.org/wiki/Plane_\(Unicode\)#Basic_Multilingual_Plane) are considered a two distinct characters. See [#58](https://github.com/stevemao/left-pad/issues/58).