From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- src/node_modules/chance/docs/helpers/pad.md | 40 +++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 src/node_modules/chance/docs/helpers/pad.md (limited to 'src/node_modules/chance/docs/helpers/pad.md') diff --git a/src/node_modules/chance/docs/helpers/pad.md b/src/node_modules/chance/docs/helpers/pad.md new file mode 100644 index 0000000..8606767 --- /dev/null +++ b/src/node_modules/chance/docs/helpers/pad.md @@ -0,0 +1,40 @@ +# pad + +```js +// usage +chance.pad(number, width) +chance.pad(number, width, padder) +``` + +Pad a number with some string until it reaches a desired width. + +By default, `chance.pad()` will pad with zeroes. For example, to zero-pad +numbers such that the outcome width is 5, do the following. + +```js +chance.pad(45, 5) +=> '00045' + +chance.pad(284, 5) +=> '00284' + +chance.pad(82843, 5) +=> '82843' +``` + +Notice how every item returned is a string with leading zeroes until the width +is 5 for each one. + +Can optionally specify a character if the desire is to pad with something other +than zero. + +```js +chance.pad(81, 5, 'Z') +=> 'ZZZ81' + +chance.pad(692, 5, 'Z') +=> 'ZZ692' + +chance.pad(52859, 5) +=> '52859' +``` -- cgit