About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

lpad

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Left pad a string.

Installation

To use as a general utility, install the CLI package globally

``bash npm install -g @stdlib/string-left-pad-cli`

`Usage`

`text Usage: lpad [options] --len= []

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][mdn-regexp], ensure that the split option is either properly escaped or enclosed in quotes.

`bash # Not escaped... $ echo -n $'beep\nboop' | lpad -len 8 --split /\r?\n/

# Escaped... $ echo -n $'beep\nboop' | lpad -len 8 --split /\\r?\\n/`

- The implementation ignores trailing delimiters.

`Examples`

`bash $ lpad beep --len 10 --pad b bbbbbbbeep`

To use as a [standard stream][standard-streams],

`bash $ echo -n 'beep' | lpad --len 8 beep`

By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

`bash $ echo -n 'boop\tbeep' | lpad --len 8 --split '\t' boop beep`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

`$3`

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/string-left-pad-cli.svg [npm-url]: https://npmjs.org/package/@stdlib/string-left-pad-cli

[test-image]: https://github.com/stdlib-js/string-left-pad/actions/workflows/test.yml/badge.svg?branch=v0.2.3 [test-url]: https://github.com/stdlib-js/string-left-pad/actions/workflows/test.yml?query=branch:v0.2.3

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-left-pad/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/string-left-pad?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[cli-section]: https://github.com/stdlib-js/string-left-pad#cli [cli-url]: https://github.com/stdlib-js/string-left-pad/tree/cli [@stdlib/string-left-pad]: https://www.npmjs.com/package/@stdlib/string-left-pad

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/string-left-pad/tree/deno [deno-readme]: https://github.com/stdlib-js/string-left-pad/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/string-left-pad/tree/umd [umd-readme]: https://github.com/stdlib-js/string-left-pad/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/string-left-pad/tree/esm [esm-readme]: https://github.com/stdlib-js/string-left-pad/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/string-left-pad/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-left-pad/main/LICENSE

[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams

[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions

[mdn-string-padstart]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart

[@stdlib/string/pad]: https://www.npmjs.com/package/@stdlib/string-pad

[@stdlib/string/right-pad]: https://www.npmjs.com/package/@stdlib/string-right-pad


  
    About stdlib...
  

  We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

  The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

  When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

  To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

`lpad`

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Left pad a string.

`Installation`

To use as a general utility, install the CLI package globally

``bash npm install -g @stdlib/string-left-pad-cli `

`Usage`

`text Usage: lpad [options] --len= []

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][mdn-regexp], ensure that the split option is either properly escaped or enclosed in quotes.

`bash # Not escaped... $ echo -n $'beep\nboop' | lpad -len 8 --split /\r?\n/

# Escaped... $ echo -n $'beep\nboop' | lpad -len 8 --split /\\r?\\n/ `

- The implementation ignores trailing delimiters.

`Examples`

`bash $ lpad beep --len 10 --pad b bbbbbbbeep `

To use as a [standard stream][standard-streams],

`bash $ echo -n 'beep' | lpad --len 8 beep `

By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

`bash $ echo -n 'boop\tbeep' | lpad --len 8 --split '\t' boop beep `