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
"username"
External module "username"
Index
Interfaces
IUsername
Options
Variables
RANDOM_
OPTIONS
Functions
name
Options
replace
Special
username
username
Defaults
Variables
Const
RANDOM_
OPTIONS
RANDOM_
OPTIONS
:
string
[]
= ['aaaa aa', 'aaa axxxx', 'axaxa xa', 'xxxx xx', 'xxxxxx xxxxx','aaaaaa aaaaa', 'aaaxxaaa aaa', 'aaa aaaxxaa']
Functions
Const
name
Options
name
Options
(
)
:
object
Returns
object
female
:
boolean
format
:
any
male
:
boolean
Const
replace
Special
replace
Special
(
value
:
string
, replaceWith
?:
string
)
:
string
Parameters
value:
string
Default value
replaceWith:
string
= ""
Returns
string
Const
username
username
(
options
?:
IUsernameOptions
)
:
string
Generates Random Username based on given parameters
Default options will be empty javaScript Object
If Person name is Off, then random user Id will be used by default
Special Characters (., -, _) all are optional and Off by default
Parameters
Default value
options:
IUsernameOptions
= usernameDefaults()
Returns
string
Const
username
Defaults
username
Defaults
(
)
:
TRequired
<
IUsernameOptions
>
Returns
TRequired
<
IUsernameOptions
>
Globals
"address"
"alphanumeric"
"color"
"company"
"credit-
card"
"currency"
"date-
time"
"duration"
"email"
"gender"
"geographic"
"password"
"person-
name"
"phone-
no"
"random"
"username"
IUsername
Options
RANDOM_
OPTIONS
name
Options
replace
Special
username
username
Defaults
Generated using
TypeDoc
Generates Random Username based on given parameters