summaryrefslogtreecommitdiff
path: root/cli/tests/testdata/commonjs/node_modules/left-pad/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cli/tests/testdata/commonjs/node_modules/left-pad/README.md')
-rw-r--r--cli/tests/testdata/commonjs/node_modules/left-pad/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/cli/tests/testdata/commonjs/node_modules/left-pad/README.md b/cli/tests/testdata/commonjs/node_modules/left-pad/README.md
new file mode 100644
index 000000000..0e70d461e
--- /dev/null
+++ b/cli/tests/testdata/commonjs/node_modules/left-pad/README.md
@@ -0,0 +1,41 @@
+## left-pad
+
+String left pad
+
+[![Build Status][travis-image]][travis-url]
+
+## 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).
+
+[travis-image]: https://travis-ci.org/stevemao/left-pad.svg?branch=master
+[travis-url]: https://travis-ci.org/stevemao/left-pad