diff options
Diffstat (limited to 'src/node_modules/chance/docs/web')
-rw-r--r-- | src/node_modules/chance/docs/web/avatar.md | 42 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/color.md | 48 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/company.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/domain.md | 22 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/email.md | 21 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/fbid.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/google_analytics.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/hashtag.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/ip.md | 14 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/ipv6.md | 14 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/klout.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/profession.md | 21 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/tld.md | 16 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/twitter.md | 13 | ||||
-rw-r--r-- | src/node_modules/chance/docs/web/url.md | 53 |
15 files changed, 329 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/web/avatar.md b/src/node_modules/chance/docs/web/avatar.md new file mode 100644 index 0000000..8feaff0 --- /dev/null +++ b/src/node_modules/chance/docs/web/avatar.md @@ -0,0 +1,42 @@ +# avatar + +```js +// usage +chance.avatar() +chance.avatar({protocol: 'https'}) +chance.avatar({fileExtension: 'jpg'}) +chance.avatar({email: 'mail@victorquinn.com'}) +``` + +Return a URL to a random avatar from Gravatar. + +```js +chance.avatar() +=> '//www.gravatar.com/avatar/41f84bab4a852971eb1d26a287acb763' +``` + +By default, a url is returned without a protocol. Specify one to get a random +url but with a known protocol + +```js +chance.avatar({protocol: 'https'}) +=> 'https://www.gravatar.com/avatar/f40260c4058cc904b7db652c26099966' +``` + +Optionally specify a file extension to get one of a known type + +```js +chance.avatar({fileExtension: 'jpg'}) +=> '//www.gravatar.com/avatar/76697df5874c854e3cc8fde1200b4298.jpg' +``` + +You can also use it with a known email address to just get that gravatar. + +However, note this, of course, no longer makes it random, just more of a helper +function: + +```js +chance.avatar({email: 'mail@victorquinn.com'}) +=> 'www.gravatar.com/avatar/8595c2591b0bca22e736813af33fa7c3' +``` + diff --git a/src/node_modules/chance/docs/web/color.md b/src/node_modules/chance/docs/web/color.md new file mode 100644 index 0000000..462e843 --- /dev/null +++ b/src/node_modules/chance/docs/web/color.md @@ -0,0 +1,48 @@ +# color + +```js +// usage +chance.color() +chance.color({format: 'hex'}) +chance.color({grayscale: true}) +chance.color({casing: 'upper'}) +``` + +Return a random color. + +```js +chance.color() +=> '#79c157' +``` + +Colors have four base types: `hex`, `shorthex`, `rgb`, `0x` + +These are the kinds usable in HTML or CSS. The type can optionally be specified + +```js +chance.color({format: 'hex'}) +=> '#d67118' + +chance.color({format: 'shorthex'}) +=> '#60f' + +chance.color({format: 'rgb'}) +=> 'rgb(110,52,164)' + +chance.color({format: '0x'}) +=> '0x67ae0b' +``` + +Can optionally specify that only grayscale colors be generated + +```js +chance.color({grayscale: true}) +=> '#e2e2e2' +``` + +Optionally specify casing to get only uppercase letters in the color + +```js +chance.color({casing: 'upper'}) +=> '#29CFA7' +``` diff --git a/src/node_modules/chance/docs/web/company.md b/src/node_modules/chance/docs/web/company.md new file mode 100644 index 0000000..73f1bfb --- /dev/null +++ b/src/node_modules/chance/docs/web/company.md @@ -0,0 +1,13 @@ +# company + +```js +// usage +chance.company() +``` + +Return a random company name. + +```js +chance.company() +=> 'Caremark Rx Inc' +``` diff --git a/src/node_modules/chance/docs/web/domain.md b/src/node_modules/chance/docs/web/domain.md new file mode 100644 index 0000000..92aa11a --- /dev/null +++ b/src/node_modules/chance/docs/web/domain.md @@ -0,0 +1,22 @@ +# domain + +```js +// usage +chance.domain() +chance.domain({tld: 'com'}) +``` + +Return a random domain with a random [tld](#tld). + +```js +chance.domain() +=> 'onaro.net' +``` + +Optionally specify a tld and the domain will be random but the tld will not. + +```js +chance.domain({tld: 'ie'}) +=> 'gotaujo.ie' +``` + diff --git a/src/node_modules/chance/docs/web/email.md b/src/node_modules/chance/docs/web/email.md new file mode 100644 index 0000000..2d91d54 --- /dev/null +++ b/src/node_modules/chance/docs/web/email.md @@ -0,0 +1,21 @@ +# email + +```js +// usage +chance.email() +chance.email({domain: "example.com"}) +``` + +Return a random email with a random domain. + +```js +chance.email() +=> 'kawip@piklojzob.gov' +``` + +Optionally specify a domain and the email will be random but the domain will not. + +```js +chance.email({domain: 'example.com'}) +=> 'giigjom@example.com' +``` diff --git a/src/node_modules/chance/docs/web/fbid.md b/src/node_modules/chance/docs/web/fbid.md new file mode 100644 index 0000000..b872517 --- /dev/null +++ b/src/node_modules/chance/docs/web/fbid.md @@ -0,0 +1,13 @@ +# fbid + +```js +// usage +chance.fbid() +``` + +Return a random Facebook id, aka fbid. + +```js +chance.fbid() +=> "1000039460258605" +``` diff --git a/src/node_modules/chance/docs/web/google_analytics.md b/src/node_modules/chance/docs/web/google_analytics.md new file mode 100644 index 0000000..54562c6 --- /dev/null +++ b/src/node_modules/chance/docs/web/google_analytics.md @@ -0,0 +1,13 @@ +# google_analytics + +```js +// usage +chance.google_analytics() +``` + +Return a random [Google Analytics](https://support.google.com/analytics/answer/1032385?hl=en) tracking code. Takes the form `'UA-123456-01'` + +```js +chance.google_analytics() +=> 'UA-384555-17' +``` diff --git a/src/node_modules/chance/docs/web/hashtag.md b/src/node_modules/chance/docs/web/hashtag.md new file mode 100644 index 0000000..50958e0 --- /dev/null +++ b/src/node_modules/chance/docs/web/hashtag.md @@ -0,0 +1,13 @@ +# hashtag + +```js +// usage +chance.hashtag() +``` + +Return a random hashtag. This is a string of the form '#thisisahashtag'. + +```js +chance.hashtag() +=> '#dichumwa' +``` diff --git a/src/node_modules/chance/docs/web/ip.md b/src/node_modules/chance/docs/web/ip.md new file mode 100644 index 0000000..d902422 --- /dev/null +++ b/src/node_modules/chance/docs/web/ip.md @@ -0,0 +1,14 @@ +# ip + +```js +// usage +chance.ip() +``` + +Return a random IP Address. + +```js +chance.ip() +=> '153.208.102.234' +``` + diff --git a/src/node_modules/chance/docs/web/ipv6.md b/src/node_modules/chance/docs/web/ipv6.md new file mode 100644 index 0000000..b13cdab --- /dev/null +++ b/src/node_modules/chance/docs/web/ipv6.md @@ -0,0 +1,14 @@ +# ipv6 + +```js +// usage +chance.ipv6() +``` + +Return a random IPv6 Address. + +```js +chance.ipv6() +=> 'db2f:6123:f99e:00f7:a76e:7f68:9f91:bb08' +``` + diff --git a/src/node_modules/chance/docs/web/klout.md b/src/node_modules/chance/docs/web/klout.md new file mode 100644 index 0000000..016031c --- /dev/null +++ b/src/node_modules/chance/docs/web/klout.md @@ -0,0 +1,13 @@ +# klout + +```js +// usage +chance.klout() +``` + +Return a random [Klout](http://klout.com) score. Range 1-99. + +```js +chance.klout() +=> 21 +``` diff --git a/src/node_modules/chance/docs/web/profession.md b/src/node_modules/chance/docs/web/profession.md new file mode 100644 index 0000000..a1bea16 --- /dev/null +++ b/src/node_modules/chance/docs/web/profession.md @@ -0,0 +1,21 @@ +# profession + +```js +// usage +chance.profession() +chance.profession({rank: true}) +``` + +Return a random profession. Rank is false by default. + +```js +chance.profession() +=> 'Software Test Engineer' +``` + +Optionally set rank as true get rank with profession. + +```js +chance.profession({rank: true}) +=> 'Junior Supply Chain Director' +``` diff --git a/src/node_modules/chance/docs/web/tld.md b/src/node_modules/chance/docs/web/tld.md new file mode 100644 index 0000000..4d63fb4 --- /dev/null +++ b/src/node_modules/chance/docs/web/tld.md @@ -0,0 +1,16 @@ +# tld + +```js +// usage +chance.tld() +``` + +Return a random tld ([Top Level Domain][tld]) from the set: + +```js +['com', 'org', 'edu', 'gov', 'uk', 'net', 'io'] +``` + +Note, these do not start with a period. + +[tld]: https://en.wikipedia.org/wiki/Top-level_domain diff --git a/src/node_modules/chance/docs/web/twitter.md b/src/node_modules/chance/docs/web/twitter.md new file mode 100644 index 0000000..24d66e9 --- /dev/null +++ b/src/node_modules/chance/docs/web/twitter.md @@ -0,0 +1,13 @@ +# twitter + +```js +// usage +chance.twitter() +``` + +Return a random twitter handle. + +```js +chance.twitter() +=> "@guspejani" +``` diff --git a/src/node_modules/chance/docs/web/url.md b/src/node_modules/chance/docs/web/url.md new file mode 100644 index 0000000..cb93848 --- /dev/null +++ b/src/node_modules/chance/docs/web/url.md @@ -0,0 +1,53 @@ +# url + +```js +// usage +chance.url() +chance.url({protocol: 'ftp'}) +chance.url({domain: 'www.socialradar.com'}) +chance.url({domain_prefix: 'docs'}) +chance.url({path: 'images'}) +chance.url({extensions: ['gif', 'jpg', 'png']}) +``` + +Return a random url. + +```js +chance.url() +=> 'http://vanogsi.io/pateliivi' +``` + +Optionally specify a protocol and the url will be random but the protocol will not. + +```js +chance.url({protocol: 'ftp'}) +=> 'ftp://mibfu.nr/kardate' +``` + +Optionally specify a domain and the url will be random but the domain will not. + +```js +chance.url({domain: 'www.socialradar.com'}) +=> 'http://www.socialradar.com/hob' +``` + +Optionally specify a domain prefix and domain will be random, and domain prefix will not. + +```js +chance.url({domain_prefix: 'docs'}) +=> 'http://docs.tuos.ni/itecabup' +``` + +Optionally specify a path and it will be obeyed. + +```js +chance.url({path: 'images'}) +=> 'http://tainvoz.net/images' +``` + +Optionally specify an array of extensions and one will be picked at random. + +```js +chance.url({extensions: ['gif', 'jpg', 'png']}) +=> 'http://vagjiup.gov/udmopke.png' +``` |