Search
Preparing search index...
The search index is not available
@servicestack/ui
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@servicestack/ui
client
Module client
Index
Enumerations
Ready
State
Classes
Api
Result
Empty
Response
Error
Response
Get
Access
Token
Response
Get
Event
Subscribers
Get
Nav
Items
Get
Nav
Items
Response
Http
Methods
Inspect
JSV
Json
Service
Client
Link
Button
Defaults
Metadata
Attribute
Metadata
Data
Contract
Metadata
Data
Member
Metadata
Operation
Type
Metadata
Property
Type
Metadata
Route
Metadata
Type
Metadata
Type
Name
Metadata
Types
Metadata
Types
Config
Nav
Button
Group
Defaults
Nav
Defaults
Nav
Item
Nav
Link
Defaults
Nav
Options
Navbar
Defaults
New
Instance
Resolver
Response
Error
Response
Status
Server
Event
Receiver
Server
Event
User
Server
Events
Client
Singleton
Instance
Resolver
String
Buffer
Update
Event
Subscriber
Update
Event
Subscriber
Response
User
Attributes
Interfaces
Api
Request
Api
Response
Cookie
IAjax
Form
Options
IAuth
Session
IBind
Handlers
Options
ICreate
Element
Options
IEvent
Source
Init
IEvent
Source
Options
IEvent
Source
Static
IOn
Message
Event
IReceiver
IReconnect
Server
Events
Options
IRequest
Filter
Options
IRequest
Init
IResolver
IReturn
IReturn
Void
ISend
Request
IValidation
Server
Event
Command
Server
Event
Connect
Server
Event
Heartbeat
Server
Event
Join
Server
Event
Leave
Server
Event
Message
Server
Event
Update
Type Aliases
Error
Response
Type
Variables
Bootstrap
Colors
Bootstrap
Sizes
Functions
$$
$1
Event
Bus
active
Class
active
Class
Nav
ajax
Submit
align
Auto
align
Center
align
Left
align
Right
api
Value
api
Value
Fmt
append
Query
String
apply
bind
Handlers
bootstrap
bootstrap
Form
btn
Classes
btn
Color
Class
btn
Size
Class
bytes
To
Base64
chop
class
Names
combine
Paths
create
Bus
create
Element
create
Error
create
Error
Status
create
Field
Error
create
Path
create
Url
css
date
Fmt
date
FmtHM
delay
Set
each
enc
error
Response
error
Response
Except
error
Response
Summary
flat
Map
form
Submit
from
Byte
Array
from
Date
Time
from
Guid
from
Time
Span
from
Xsd
Duration
get
Field
get
Method
get
Response
Status
html
Attrs
humanify
humanize
index
Of
Any
is
Date
is
Digit
is
Form
Data
is
Lower
is
Null
Or
Empty
is
Upper
last
Left
Part
last
Right
Part
left
Part
map
Get
name
Of
normalize
normalize
Key
omit
on
only
Props
pad
Int
parse
Cookie
parse
Response
Status
pick
populate
Form
query
String
resolve
right
Part
safe
Var
Name
sanitize
serialize
Form
serialize
To
Form
Data
serialize
To
Object
serialize
To
Url
Encoded
split
On
First
split
On
Last
split
Title
Case
strip
Quotes
time
Fmt12
to
Base64
String
to
Byte
Array
to
Camel
Case
to
Date
to
Date
Fmt
to
Date
Time
to
Form
Data
to
Guid
to
LocalISOString
to
Object
to
Pascal
Case
to
Time
Span
to
Time
Span
Fmt
to
Var
Names
to
Xsd
Duration
trigger
Event
trim
End
try
Decode
uc
First
uniq
unique
Keys
Type Aliases
Error
Response
Type
Error
Response
Type
:
null
|
"RefreshTokenException"
Variables
Const
Bootstrap
Colors
Bootstrap
Colors
:
string
[]
Const
Bootstrap
Sizes
Bootstrap
Sizes
:
string
[]
Functions
$$
$$
(
sel
:
any
, el
?:
HTMLElement
)
:
any
Parameters
sel:
any
Optional
el:
HTMLElement
Returns
any
$1
$1
(
sel
:
any
, el
?:
HTMLElement
)
:
any
Parameters
sel:
any
Optional
el:
HTMLElement
Returns
any
Event
Bus
Event
Bus
(
)
:
void
Returns
void
active
Class
active
Class
(
href
:
string
, activePath
:
string
, exact
?:
boolean
)
:
string
Parameters
href:
string
activePath:
string
Optional
exact:
boolean
Returns
string
active
Class
Nav
active
Class
Nav
(
x
:
NavItem
, activePath
:
string
)
:
string
Parameters
x:
NavItem
activePath:
string
Returns
string
ajax
Submit
ajax
Submit
(
f
:
HTMLFormElement
, options
?:
IAjaxFormOptions
)
:
any
Parameters
f:
HTMLFormElement
Optional
options:
IAjaxFormOptions
Returns
any
align
Auto
align
Auto
(
obj
:
any
, len
:
number
, pad
?:
string
)
:
string
Parameters
obj:
any
len:
number
Optional
pad:
string
Returns
string
align
Center
align
Center
(
str
:
string
, len
:
number
, pad
?:
string
)
:
string
Parameters
str:
string
len:
number
Optional
pad:
string
Returns
string
align
Left
align
Left
(
str
:
string
, len
:
number
, pad
?:
string
)
:
string
Parameters
str:
string
len:
number
Optional
pad:
string
Returns
string
align
Right
align
Right
(
str
:
string
, len
:
number
, pad
?:
string
)
:
string
Parameters
str:
string
len:
number
Optional
pad:
string
Returns
string
api
Value
api
Value
(
o
:
any
)
:
any
Parameters
o:
any
Returns
any
api
Value
Fmt
api
Value
Fmt
(
o
:
any
)
:
any
Parameters
o:
any
Returns
any
append
Query
String
append
Query
String
(
url
:
string
, args
:
any
)
:
string
Parameters
url:
string
args:
any
Returns
string
apply
apply
<
T
>
(
x
:
T
, fn
:
(
(
x
:
T
)
=>
void
)
)
:
T
Type Parameters
T
Parameters
x:
T
fn:
(
(
x
:
T
)
=>
void
)
(
x
:
T
)
:
void
Parameters
x:
T
Returns
void
Returns
T
bind
Handlers
bind
Handlers
(
handlers
:
any
, el
?:
Element
|
Document
, opt
?:
IBindHandlersOptions
)
:
void
Parameters
handlers:
any
Optional
el:
Element
|
Document
Optional
opt:
IBindHandlersOptions
Returns
void
bootstrap
bootstrap
(
el
?:
Element
)
:
void
Parameters
Optional
el:
Element
Returns
void
bootstrap
Form
bootstrap
Form
(
form
:
HTMLFormElement
, options
:
IAjaxFormOptions
)
:
void
Parameters
form:
HTMLFormElement
options:
IAjaxFormOptions
Returns
void
btn
Classes
btn
Classes
(
props
:
any
)
:
any
[]
Parameters
props:
any
Returns
any
[]
btn
Color
Class
btn
Color
Class
(
props
:
any
)
:
string
Parameters
props:
any
Returns
string
btn
Size
Class
btn
Size
Class
(
props
:
any
)
:
string
Parameters
props:
any
Returns
string
bytes
To
Base64
bytes
To
Base64
(
aBytes
:
Uint8Array
)
:
string
Parameters
aBytes:
Uint8Array
Returns
string
chop
chop
(
str
:
string
, len
?:
number
)
:
string
Parameters
str:
string
Optional
len:
number
Returns
string
class
Names
class
Names
(
...
args
:
any
[]
)
:
string
Parameters
Rest
...
args:
any
[]
Returns
string
combine
Paths
combine
Paths
(
...
paths
:
string
[]
)
:
string
Parameters
Rest
...
paths:
string
[]
Returns
string
create
Bus
create
Bus
(
)
:
{
publish
:
any
;
subscribe
:
any
}
Returns
{
publish
:
any
;
subscribe
:
any
}
publish
:
function
publish
(
eventType
:
string
, arg
:
any
)
:
void
Parameters
eventType:
string
arg:
any
Returns
void
subscribe
:
function
subscribe
(
type
:
string
, callback
:
Function
)
:
{
unsubscribe
:
any
}
Parameters
type:
string
callback:
Function
Returns
{
unsubscribe
:
any
}
unsubscribe
:
function
unsubscribe
(
)
:
void
Returns
void
create
Element
create
Element
(
tagName
:
string
, options
?:
ICreateElementOptions
, attrs
?:
any
)
:
HTMLElement
Parameters
tagName:
string
Optional
options:
ICreateElementOptions
Optional
attrs:
any
Returns
HTMLElement
create
Error
create
Error
(
errorCode
:
string
, message
:
string
, fieldName
?:
string
)
:
ErrorResponse
Parameters
errorCode:
string
message:
string
Optional
fieldName:
string
Returns
ErrorResponse
create
Error
Status
create
Error
Status
(
message
:
string
, errorCode
?:
string
)
:
ResponseStatus
Parameters
message:
string
Optional
errorCode:
string
Returns
ResponseStatus
create
Field
Error
create
Field
Error
(
fieldName
:
string
, message
:
string
, errorCode
?:
string
)
:
ResponseStatus
Parameters
fieldName:
string
message:
string
Optional
errorCode:
string
Returns
ResponseStatus
create
Path
create
Path
(
route
:
string
, args
:
any
)
:
string
Parameters
route:
string
args:
any
Returns
string
create
Url
create
Url
(
route
:
string
, args
:
any
)
:
string
Parameters
route:
string
args:
any
Returns
string
css
css
(
selector
:
string
|
NodeListOf
<
Element
>
, name
:
string
, value
:
string
)
:
void
Parameters
selector:
string
|
NodeListOf
<
Element
>
name:
string
value:
string
Returns
void
date
Fmt
date
Fmt
(
d
?:
Date
)
:
string
Parameters
Optional
d:
Date
Returns
string
date
FmtHM
date
FmtHM
(
d
?:
Date
)
:
string
Parameters
Optional
d:
Date
Returns
string
delay
Set
delay
Set
(
f
:
(
(
loading
:
boolean
)
=>
any
)
, opt
?:
{
duration
?:
number
}
)
:
(
(
)
=>
void
)
Parameters
f:
(
(
loading
:
boolean
)
=>
any
)
(
loading
:
boolean
)
:
any
Parameters
loading:
boolean
Returns
any
Optional
opt:
{
duration
?:
number
}
Optional
duration
?:
number
Returns
(
(
)
=>
void
)
(
)
:
void
Returns
void
each
each
(
xs
:
any
[]
, f
:
(
(
acc
:
any
, x
:
any
)
=>
void
)
, o
?:
any
)
:
any
Parameters
xs:
any
[]
f:
(
(
acc
:
any
, x
:
any
)
=>
void
)
(
acc
:
any
, x
:
any
)
:
void
Parameters
acc:
any
x:
any
Returns
void
Optional
o:
any
Returns
any
enc
enc
(
o
:
any
)
:
string
Parameters
o:
any
Returns
string
error
Response
error
Response
(
fieldName
:
string
)
:
any
Parameters
fieldName:
string
Returns
any
error
Response
Except
error
Response
Except
(
fieldNames
:
string
|
string
[]
)
:
any
Parameters
fieldNames:
string
|
string
[]
Returns
any
error
Response
Summary
error
Response
Summary
(
)
:
any
Returns
any
flat
Map
flat
Map
(
f
:
Function
, xs
:
any
[]
)
:
any
Parameters
f:
Function
xs:
any
[]
Returns
any
form
Submit
form
Submit
(
this
:
HTMLFormElement
, options
?:
IAjaxFormOptions
)
:
Promise
<
any
>
Parameters
this:
HTMLFormElement
Optional
options:
IAjaxFormOptions
Returns
Promise
<
any
>
from
Byte
Array
from
Byte
Array
(
base64
:
string
)
:
Uint8Array
Parameters
base64:
string
Returns
Uint8Array
from
Date
Time
from
Date
Time
(
dateTime
:
string
)
:
Date
Parameters
dateTime:
string
Returns
Date
from
Guid
from
Guid
(
xsdDuration
:
string
)
:
string
Parameters
xsdDuration:
string
Returns
string
from
Time
Span
from
Time
Span
(
xsdDuration
:
string
)
:
string
Parameters
xsdDuration:
string
Returns
string
from
Xsd
Duration
from
Xsd
Duration
(
xsd
:
string
)
:
number
Parameters
xsd:
string
Returns
number
get
Field
get
Field
(
o
:
any
, name
:
string
)
:
any
Parameters
o:
any
name:
string
Returns
any
get
Method
get
Method
(
request
:
any
, method
?:
string
)
:
any
Parameters
request:
any
Optional
method:
string
Returns
any
get
Response
Status
get
Response
Status
(
e
:
any
)
:
any
Parameters
e:
any
Returns
any
html
Attrs
html
Attrs
(
o
:
any
)
:
string
Parameters
o:
any
Returns
string
humanify
humanify
(
s
:
any
)
:
any
Parameters
s:
any
Returns
any
humanize
humanize
(
s
:
any
)
:
any
Parameters
s:
any
Returns
any
index
Of
Any
index
Of
Any
(
str
:
string
, needles
:
string
[]
)
:
number
Parameters
str:
string
needles:
string
[]
Returns
number
is
Date
is
Date
(
d
:
any
)
:
boolean
Parameters
d:
any
Returns
boolean
is
Digit
is
Digit
(
c
:
string
)
:
boolean
Parameters
c:
string
Returns
boolean
is
Form
Data
is
Form
Data
(
body
:
any
)
:
boolean
Parameters
body:
any
Returns
boolean
is
Lower
is
Lower
(
c
:
string
)
:
boolean
Parameters
c:
string
Returns
boolean
is
Null
Or
Empty
is
Null
Or
Empty
(
o
:
any
)
:
boolean
Parameters
o:
any
Returns
boolean
is
Upper
is
Upper
(
c
:
string
)
:
boolean
Parameters
c:
string
Returns
boolean
last
Left
Part
last
Left
Part
(
s
:
string
, needle
:
string
)
:
string
Parameters
s:
string
needle:
string
Returns
string
last
Right
Part
last
Right
Part
(
s
:
string
, needle
:
string
)
:
string
Parameters
s:
string
needle:
string
Returns
string
left
Part
left
Part
(
s
:
string
, needle
:
string
)
:
string
Parameters
s:
string
needle:
string
Returns
string
map
Get
map
Get
(
o
:
any
, name
:
string
)
:
any
Parameters
o:
any
name:
string
Returns
any
name
Of
name
Of
(
o
:
any
)
:
any
Parameters
o:
any
Returns
any
normalize
normalize
(
dto
:
any
, deep
?:
boolean
)
:
any
Parameters
dto:
any
Optional
deep:
boolean
Returns
any
normalize
Key
normalize
Key
(
key
:
string
)
:
string
Parameters
key:
string
Returns
string
omit
omit
(
o
:
any
, keys
:
string
[]
)
:
{}
Parameters
o:
any
keys:
string
[]
Returns
{}
on
on
(
sel
:
any
, handlers
:
any
)
:
void
Parameters
sel:
any
handlers:
any
Returns
void
only
Props
only
Props
(
obj
:
{}
, keys
:
string
[]
)
:
{}
Parameters
obj:
{}
[
index:
string
]:
any
keys:
string
[]
Returns
{}
[
index:
string
]:
any
pad
Int
pad
Int
(
n
:
number
)
:
string
|
number
Parameters
n:
number
Returns
string
|
number
parse
Cookie
parse
Cookie
(
setCookie
:
string
)
:
Cookie
Parameters
setCookie:
string
Returns
Cookie
parse
Response
Status
parse
Response
Status
(
json
:
string
, defaultMsg
?:
any
)
:
any
Parameters
json:
string
Optional
defaultMsg:
any
Returns
any
pick
pick
(
o
:
any
, keys
:
string
[]
)
:
{}
Parameters
o:
any
keys:
string
[]
Returns
{}
populate
Form
populate
Form
(
form
:
HTMLFormElement
, model
:
any
)
:
void
Parameters
form:
HTMLFormElement
model:
any
Returns
void
query
String
query
String
(
url
:
string
)
:
any
Parameters
url:
string
Returns
any
resolve
resolve
<
T
>
(
o
:
T
, f
?:
(
(
x
:
T
)
=>
any
)
)
:
any
Type Parameters
T
Parameters
o:
T
Optional
f:
(
(
x
:
T
)
=>
any
)
(
x
:
T
)
:
any
Parameters
x:
T
Returns
any
Returns
any
right
Part
right
Part
(
s
:
string
, needle
:
string
)
:
string
Parameters
s:
string
needle:
string
Returns
string
safe
Var
Name
safe
Var
Name
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
sanitize
sanitize
(
status
:
any
)
:
any
Parameters
status:
any
Returns
any
serialize
Form
serialize
Form
(
form
:
HTMLFormElement
, contentType
?:
string
)
:
string
|
FormData
Parameters
form:
HTMLFormElement
Optional
contentType:
string
Returns
string
|
FormData
serialize
To
Form
Data
serialize
To
Form
Data
(
form
:
HTMLFormElement
)
:
FormData
Parameters
form:
HTMLFormElement
Returns
FormData
serialize
To
Object
serialize
To
Object
(
form
:
HTMLFormElement
)
:
any
Parameters
form:
HTMLFormElement
Returns
any
serialize
To
Url
Encoded
serialize
To
Url
Encoded
(
form
:
HTMLFormElement
)
:
string
Parameters
form:
HTMLFormElement
Returns
string
split
On
First
split
On
First
(
s
:
string
, c
:
string
)
:
string
[]
Parameters
s:
string
c:
string
Returns
string
[]
split
On
Last
split
On
Last
(
s
:
string
, c
:
string
)
:
string
[]
Parameters
s:
string
c:
string
Returns
string
[]
split
Title
Case
split
Title
Case
(
s
:
string
)
:
any
[]
Parameters
s:
string
Returns
any
[]
strip
Quotes
strip
Quotes
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
time
Fmt12
time
Fmt12
(
d
?:
Date
)
:
string
Parameters
Optional
d:
Date
Returns
string
to
Base64
String
to
Base64
String
(
source
:
string
)
:
string
Parameters
source:
string
Returns
string
to
Byte
Array
to
Byte
Array
(
bytes
:
Uint8Array
)
:
string
Parameters
bytes:
Uint8Array
Returns
string
to
Camel
Case
to
Camel
Case
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
to
Date
to
Date
(
s
:
any
)
:
Date
Parameters
s:
any
Returns
Date
to
Date
Fmt
to
Date
Fmt
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
to
Date
Time
to
Date
Time
(
date
:
Date
)
:
string
Parameters
date:
Date
Returns
string
to
Form
Data
to
Form
Data
(
o
:
any
)
:
FormData
Parameters
o:
any
Returns
FormData
to
Guid
to
Guid
(
xsdDuration
:
string
)
:
string
Parameters
xsdDuration:
string
Returns
string
to
LocalISOString
to
LocalISOString
(
d
?:
Date
)
:
string
Parameters
Optional
d:
Date
Returns
string
to
Object
to
Object
(
keys
:
any
)
:
{}
Parameters
keys:
any
Returns
{}
to
Pascal
Case
to
Pascal
Case
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
to
Time
Span
to
Time
Span
(
xsdDuration
:
string
)
:
string
Parameters
xsdDuration:
string
Returns
string
to
Time
Span
Fmt
to
Time
Span
Fmt
(
time
:
number
)
:
string
Parameters
time:
number
Returns
string
to
Var
Names
to
Var
Names
(
names
:
string
|
string
[]
)
:
string
[]
Parameters
names:
string
|
string
[]
Returns
string
[]
to
Xsd
Duration
to
Xsd
Duration
(
time
:
number
)
:
string
Parameters
time:
number
Returns
string
trigger
Event
trigger
Event
(
el
:
Element
, name
:
string
, data
?:
any
)
:
void
Parameters
el:
Element
name:
string
Optional
data:
any
Returns
void
trim
End
trim
End
(
s
:
string
, c
:
string
)
:
string
Parameters
s:
string
c:
string
Returns
string
try
Decode
try
Decode
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
uc
First
uc
First
(
s
:
string
)
:
string
Parameters
s:
string
Returns
string
uniq
uniq
(
xs
:
string
[]
)
:
string
[]
Parameters
xs:
string
[]
Returns
string
[]
unique
Keys
unique
Keys
(
rows
:
any
[]
)
:
string
[]
Parameters
rows:
any
[]
Returns
string
[]
Modules
admin
client
explorer
locode
shared
Ready
State
Api
Result
Empty
Response
Error
Response
Get
Access
Token
Response
Get
Event
Subscribers
Get
Nav
Items
Get
Nav
Items
Response
Http
Methods
Inspect
JSV
Json
Service
Client
Link
Button
Defaults
Metadata
Attribute
Metadata
Data
Contract
Metadata
Data
Member
Metadata
Operation
Type
Metadata
Property
Type
Metadata
Route
Metadata
Type
Metadata
Type
Name
Metadata
Types
Metadata
Types
Config
Nav
Button
Group
Defaults
Nav
Defaults
Nav
Item
Nav
Link
Defaults
Nav
Options
Navbar
Defaults
New
Instance
Resolver
Response
Error
Response
Status
Server
Event
Receiver
Server
Event
User
Server
Events
Client
Singleton
Instance
Resolver
String
Buffer
Update
Event
Subscriber
Update
Event
Subscriber
Response
User
Attributes
Api
Request
Api
Response
Cookie
IAjax
Form
Options
IAuth
Session
IBind
Handlers
Options
ICreate
Element
Options
IEvent
Source
Init
IEvent
Source
Options
IEvent
Source
Static
IOn
Message
Event
IReceiver
IReconnect
Server
Events
Options
IRequest
Filter
Options
IRequest
Init
IResolver
IReturn
IReturn
Void
ISend
Request
IValidation
Server
Event
Command
Server
Event
Connect
Server
Event
Heartbeat
Server
Event
Join
Server
Event
Leave
Server
Event
Message
Server
Event
Update
Error
Response
Type
Bootstrap
Colors
Bootstrap
Sizes
$$
$1
Event
Bus
active
Class
active
Class
Nav
ajax
Submit
align
Auto
align
Center
align
Left
align
Right
api
Value
api
Value
Fmt
append
Query
String
apply
bind
Handlers
bootstrap
bootstrap
Form
btn
Classes
btn
Color
Class
btn
Size
Class
bytes
To
Base64
chop
class
Names
combine
Paths
create
Bus
create
Element
create
Error
create
Error
Status
create
Field
Error
create
Path
create
Url
css
date
Fmt
date
FmtHM
delay
Set
each
enc
error
Response
error
Response
Except
error
Response
Summary
flat
Map
form
Submit
from
Byte
Array
from
Date
Time
from
Guid
from
Time
Span
from
Xsd
Duration
get
Field
get
Method
get
Response
Status
html
Attrs
humanify
humanize
index
Of
Any
is
Date
is
Digit
is
Form
Data
is
Lower
is
Null
Or
Empty
is
Upper
last
Left
Part
last
Right
Part
left
Part
map
Get
name
Of
normalize
normalize
Key
omit
on
only
Props
pad
Int
parse
Cookie
parse
Response
Status
pick
populate
Form
query
String
resolve
right
Part
safe
Var
Name
sanitize
serialize
Form
serialize
To
Form
Data
serialize
To
Object
serialize
To
Url
Encoded
split
On
First
split
On
Last
split
Title
Case
strip
Quotes
time
Fmt12
to
Base64
String
to
Byte
Array
to
Camel
Case
to
Date
to
Date
Fmt
to
Date
Time
to
Form
Data
to
Guid
to
LocalISOString
to
Object
to
Pascal
Case
to
Time
Span
to
Time
Span
Fmt
to
Var
Names
to
Xsd
Duration
trigger
Event
trim
End
try
Decode
uc
First
uniq
unique
Keys
Generated using
TypeDoc