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/basics/template.md | 27 +++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 src/node_modules/chance/docs/basics/template.md (limited to 'src/node_modules/chance/docs/basics/template.md') diff --git a/src/node_modules/chance/docs/basics/template.md b/src/node_modules/chance/docs/basics/template.md new file mode 100644 index 0000000..96ba860 --- /dev/null +++ b/src/node_modules/chance/docs/basics/template.md @@ -0,0 +1,27 @@ +# template + +Return a random string matching the given template. + +```js +// usage +chance.template('{AA####}') +=> 'ZQ7803' +chance.template('{Aa}-{##}') +=> 'Vr-78' +chance.template('{####}:{####}:{####}') +=> '1628:5987:7803' +``` + +The template consists of any number of "character replacement" and "character +literal" sequences. A "character replacement" sequence starts with a left +brace, has any number of special replacement characters, and ends with a right +brace. A character literal can be any character except a brace or a backslash. +A literal brace or backslash character can be included in the output by +escaping with a backslash. + +The following replacement characters can be used in a replacement sequence: + + * "#": a random digit + * "a": a random lower case letter + * "A": a random upper case letter + -- cgit