npm run test
npm run docs
-
boolean() ⇒
boolean
-
True or false
-
email([options]) ⇒
string
-
A random lower case email address
-
lorem([n]) ⇒
String
-
Lorem ipsum sentences
-
number([min], [max]) ⇒
number
-
Generates a random number
-
phone() ⇒
string
-
A random phone number
-
address
-
.city() ⇒
string
-
.streetAddress() ⇒
string
-
.zipCode() ⇒
string
-
.city() ⇒
The name of a random city
Kind: static method of address
A random street address
Kind: static method of address
A random five digit zip code
Kind: static method of address
Random date
Kind: inner method of date
Param | Type | Default | Description |
---|---|---|---|
[start] |
Date | String | Number
|
0 |
Start date |
[end] |
Date | String | Number
|
Date.now() |
End date |
-
name
-
~firstName() ⇒
string
-
~lastName() ⇒
string
-
~name() ⇒
string
-
~firstName() ⇒
A random first name
Kind: inner method of name
A random last name
Kind: inner method of name
A first name and a last name
Kind: inner method of name
boolean() ⇒ boolean
True or false
A random lower case email address
Kind: global function
Param | Type | Default | Description |
---|---|---|---|
[options] | Object |
{} |
Your preferred email details |
[options.prefix] | string |
Customize the left side of the @-sign | |
[options.domain] | string |
Customize the right side of the @-sign |
Lorem ipsum sentences
Kind: global function
Param | Type | Default | Description |
---|---|---|---|
[n] | number |
1 |
Number of sentences |
number([min], [max]) ⇒ number
Generates a random number
Kind: global function
Param | Type | Default |
---|---|---|
[min] | number |
0 |
[max] | number |
min+10 |
A random phone number
Kind: global function