Search
Preparing search index...
The search index is not available
rs-mock - Documentation
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"email"
External module "email"
Index
Interfaces
IEmail
Options
Variables
PUBLIC_
DOMAINS
SUB_
DOMAINS
Functions
email
email
Defaults
replace
Special
Variables
Const
PUBLIC_
DOMAINS
PUBLIC_
DOMAINS
:
string
[]
= ['google', 'gmail', 'yahoo', 'reddif', 'hotmail', 'outlook', 'gmx','msnmail', 'facebook', 'ymail', 'aolmail', 'fastmail', 'hushmail', 'runbox']
Const
SUB_
DOMAINS
SUB_
DOMAINS
:
string
[]
= ['com', 'ca', 'in', 'fa', 'org', 'net', 'es', 'cs', 'eu']
Functions
Const
email
email
(
options
?:
IEmailOptions
)
:
string
Generates Random Email Id based on given parameters
Default options will be empty javaScript Object
If Company Domain if Off, then Public domain will be used by default
Refer
./username.ts
for more details
Parameters
Default value
options:
IEmailOptions
= emailDefaults()
Returns
string
Const
email
Defaults
email
Defaults
(
)
:
TRequired
<
IEmailOptions
>
Returns
TRequired
<
IEmailOptions
>
Const
replace
Special
replace
Special
(
value
:
string
, replaceWith
?:
string
)
:
string
Parameters
value:
string
Default value
replaceWith:
string
= ""
Returns
string
Globals
"address"
"alphanumeric"
"color"
"company"
"credit-
card"
"currency"
"date-
time"
"duration"
"email"
"gender"
"geographic"
"password"
"person-
name"
"phone-
no"
"random"
"username"
IEmail
Options
PUBLIC_
DOMAINS
SUB_
DOMAINS
email
email
Defaults
replace
Special
Generated using
TypeDoc
Generates Random Email Id based on given parameters
./username.ts
for more details