https://github.com/jonschlinkert/pad-left
Left pad a string with zeros or a specified string. Fastest implementation.
https://github.com/jonschlinkert/pad-left
fill left pad repeat string
Last synced: 3 months ago
JSON representation
Left pad a string with zeros or a specified string. Fastest implementation.
- Host: GitHub
- URL: https://github.com/jonschlinkert/pad-left
- Owner: jonschlinkert
- License: mit
- Created: 2014-11-30T19:21:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-17T05:27:58.000Z (over 3 years ago)
- Last Synced: 2025-04-09T15:06:24.862Z (3 months ago)
- Topics: fill, left, pad, repeat, string
- Language: JavaScript
- Size: 35.2 KB
- Stars: 44
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pad-left [](https://www.npmjs.com/package/pad-left) [](https://npmjs.org/package/pad-left) [](https://travis-ci.org/jonschlinkert/pad-left)
Left pad a string with zeros or a specified string. Fastest implementation.
You might also be interested in [word-wrap](https://github.com/jonschlinkert/word-wrap).
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install pad-left --save
```
## Usage
```js
var pad = require('pad-left');
pad( '4', 4, '0') // 0004
pad( '35', 4, '0') // 0035
pad('459', 4, '0') // 0459
```
## Benchmarks
Benchmarks for node.js v6.5.0 versus [left-pad](https://github.com/stevemao/left-pad).
```sh
# benchmark/fixtures/10-custom-char.js (37 bytes)
pad-left x 14,660,838 ops/sec ±1.43% (84 runs sampled)
left-pad x 9,189,792 ops/sec ±1.36% (81 runs sampled)
# benchmark/fixtures/10.js (32 bytes)
pad-left x 13,357,570 ops/sec ±1.91% (84 runs sampled)
left-pad x 20,375,277 ops/sec ±1.40% (82 runs sampled)
# benchmark/fixtures/100-custom-char.js (38 bytes)
pad-left x 13,671,301 ops/sec ±1.58% (83 runs sampled)
left-pad x 8,917,004 ops/sec ±1.84% (79 runs sampled)
# benchmark/fixtures/100.js (34 bytes)
pad-left x 15,442,944 ops/sec ±1.68% (81 runs sampled)
left-pad x 7,850,636 ops/sec ±1.47% (83 runs sampled)
# benchmark/fixtures/1000-custom-char.js (40 bytes)
pad-left x 13,624,072 ops/sec ±1.25% (84 runs sampled)
left-pad x 5,907,915 ops/sec ±1.13% (86 runs sampled)
# benchmark/fixtures/1000.js (35 bytes)
pad-left x 14,241,788 ops/sec ±1.23% (81 runs sampled)
left-pad x 5,418,351 ops/sec ±1.52% (80 runs sampled)
```
## Related projects
You might also be interested in these projects:
* [align-text](https://www.npmjs.com/package/align-text): Align the text in a string. | [homepage](https://github.com/jonschlinkert/align-text)
* [center-align](https://www.npmjs.com/package/center-align): Center-align the text in a string. | [homepage](https://github.com/jonschlinkert/center-align)
* [justified](https://www.npmjs.com/package/justified): Wrap words to a specified length and justified the text. | [homepage](https://github.com/jonschlinkert/justified)
* [pad-right](https://www.npmjs.com/package/pad-right): Right pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-right)
* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string)
* [right-align-keys](https://www.npmjs.com/package/right-align-keys): Right align the keys of an object. | [homepage](https://github.com/jonschlinkert/right-align-keys)
* [right-align-values](https://www.npmjs.com/package/right-align-values): Right align the values of a given property for each object in an array. Useful… [more](https://www.npmjs.com/package/right-align-values) | [homepage](https://github.com/jonschlinkert/right-align-values)
* [right-align](https://www.npmjs.com/package/right-align): Right-align the text in a string. | [homepage](https://github.com/jonschlinkert/right-align)
* [right-pad-keys](https://www.npmjs.com/package/right-pad-keys): Right pad the keys of an object. | [homepage](https://github.com/jonschlinkert/right-pad-keys)
* [right-pad-values](https://www.npmjs.com/package/right-pad-values): Right pad the values of a given property for each object in an array. Useful… [more](https://www.npmjs.com/package/right-pad-values) | [homepage](https://github.com/jonschlinkert/right-pad-values)
* [word-wrap](https://www.npmjs.com/package/word-wrap): Wrap words to a specified length. | [homepage](https://github.com/jonschlinkert/word-wrap)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/pad-left/issues/new).
## Building docs
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install verb && npm run docs
```
Or, if [verb](https://github.com/verbose/verb) is installed globally:
```sh
$ verb
```
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/pad-left/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 07, 2016._