nushell/docs/commands/str_lpad.md
JT 8c0a2d3c15
Auto-generate markdown command docs (#4451)
* Finish updating

* a couple improvements

* Update renames

* cleanup examples
2022-02-13 21:22:51 -05:00

716 B

title layout version
str lpad command 0.59.0

pad a string with a character a certain length

Signature

> str lpad ...rest --length --character

Parameters

  • ...rest: optionally check if string contains pattern by column paths
  • --length {int}: length to pad to
  • --character {string}: character to pad with

Examples

Left pad a string with a character a number of places

> 'nushell' | str lpad -l 10 -c '*'

Left pad a string with a character a number of places

> '123' | str lpad -l 10 -c '0'

Use lpad to truncate a string

> '123456789' | str lpad -l 3 -c '0'

Use lpad to pad Unicode

> '▉' | str lpad -l 10 -c '▉'