Search
Preparing search index...
The search index is not available
swimOS
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
@swim/uri
Uri
Class Uri
Hierarchy
Uri
Implements
Comparable
<
Uri
>
HashCode
Debug
Display
Index
Methods
appended
Path
appended
Query
appended
Segment
appended
Slash
authority
authority
Part
base
base
Path
compare
To
copy
debug
display
endpoint
equals
fragment
fragment
Identifier
fragment
Part
hash
Code
host
host
Address
hostIPv4
hostIPv6
host
Name
host
Part
is
Defined
is
Empty
parent
parent
Path
password
path
path
Name
path
Part
port
port
Number
port
Part
prepended
Path
prepended
Query
prepended
Segment
prepended
Slash
query
query
Part
removed
Query
resolve
scheme
scheme
Name
scheme
Part
to
Any
to
String
unresolve
updated
Query
user
user
Part
username
authority
authority
Part
empty
form
fragment
fragment
Identifier
fragment
Part
from
from
Any
host
hostIPv4
hostIPv6
host
Name
host
Part
parse
password
path
path
Part
port
port
Number
port
Part
query
query
Part
scheme
scheme
Name
scheme
Part
standard
Parser
user
user
Part
username
Methods
appended
Path
appended
Path
(
...
components
:
AnyUriPath
[]
)
:
Uri
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
Uri
appended
Query
appended
Query
(
key
:
string
|
null
, value
:
string
)
:
Uri
appended
Query
(
params
:
AnyUriQuery
)
:
Uri
Parameters
key:
string
|
null
value:
string
Returns
Uri
Parameters
params:
AnyUriQuery
Returns
Uri
appended
Segment
appended
Segment
(
segment
:
string
)
:
Uri
Parameters
segment:
string
Returns
Uri
appended
Slash
appended
Slash
(
)
:
Uri
Returns
Uri
authority
authority
(
)
:
UriAuthority
authority
(
authority
:
AnyUriAuthority
)
:
Uri
Returns
UriAuthority
Parameters
authority:
AnyUriAuthority
Returns
Uri
authority
Part
authority
Part
(
)
:
string
authority
Part
(
authority
:
string
)
:
Uri
Returns
string
Parameters
authority:
string
Returns
Uri
base
base
(
)
:
Uri
Returns
Uri
base
Path
base
Path
(
)
:
UriPath
Returns
UriPath
compare
To
compare
To
(
that
:
Uri
)
:
0
|
1
|
-1
Parameters
that:
Uri
Returns
0
|
1
|
-1
Protected
copy
copy
(
scheme
:
UriScheme
, authority
:
UriAuthority
, path
:
UriPath
, query
:
UriQuery
, fragment
:
UriFragment
)
:
Uri
Parameters
scheme:
UriScheme
authority:
UriAuthority
path:
UriPath
query:
UriQuery
fragment:
UriFragment
Returns
Uri
debug
debug
(
output
:
Output
)
:
void
Parameters
output:
Output
Returns
void
display
display
(
output
:
Output
)
:
void
Parameters
output:
Output
Returns
void
endpoint
endpoint
(
)
:
Uri
Returns
Uri
equals
equals
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
fragment
fragment
(
)
:
UriFragment
fragment
(
fragment
:
AnyUriFragment
)
:
Uri
Returns
UriFragment
Parameters
fragment:
AnyUriFragment
Returns
Uri
fragment
Identifier
fragment
Identifier
(
)
:
string
|
null
fragment
Identifier
(
identifier
:
string
|
null
)
:
Uri
Returns
string
|
null
Parameters
identifier:
string
|
null
Returns
Uri
fragment
Part
fragment
Part
(
)
:
string
|
null
fragment
Part
(
fragment
:
string
)
:
Uri
Returns
string
|
null
Parameters
fragment:
string
Returns
Uri
hash
Code
hash
Code
(
)
:
number
Returns
number
host
host
(
)
:
UriHost
host
(
host
:
AnyUriHost
)
:
Uri
Returns
UriHost
Parameters
host:
AnyUriHost
Returns
Uri
host
Address
host
Address
(
)
:
string
Returns
string
hostIPv4
hostIPv4
(
)
:
string
|
null
hostIPv4
(
address
:
string
)
:
Uri
Returns
string
|
null
Parameters
address:
string
Returns
Uri
hostIPv6
hostIPv6
(
)
:
string
|
null
hostIPv6
(
address
:
string
)
:
Uri
Returns
string
|
null
Parameters
address:
string
Returns
Uri
host
Name
host
Name
(
)
:
string
|
null
host
Name
(
address
:
string
)
:
Uri
Returns
string
|
null
Parameters
address:
string
Returns
Uri
host
Part
host
Part
(
)
:
string
host
Part
(
host
:
string
)
:
Uri
Returns
string
Parameters
host:
string
Returns
Uri
is
Defined
is
Defined
(
)
:
boolean
Returns
boolean
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
parent
parent
(
)
:
Uri
Returns
Uri
parent
Path
parent
Path
(
)
:
UriPath
Returns
UriPath
password
password
(
)
:
string
|
null
password
(
password
:
string
|
null
)
:
Uri
Returns
string
|
null
Parameters
password:
string
|
null
Returns
Uri
path
path
(
)
:
UriPath
path
(
...
components
:
AnyUriPath
[]
)
:
Uri
Returns
UriPath
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
Uri
path
Name
path
Name
(
)
:
string
path
Name
(
name
:
string
)
:
Uri
Returns
string
Parameters
name:
string
Returns
Uri
path
Part
path
Part
(
)
:
string
path
Part
(
path
:
string
)
:
Uri
Returns
string
Parameters
path:
string
Returns
Uri
port
port
(
)
:
UriPort
port
(
port
:
AnyUriPort
)
:
Uri
Returns
UriPort
Parameters
port:
AnyUriPort
Returns
Uri
port
Number
port
Number
(
)
:
number
port
Number
(
port
:
number
)
:
Uri
Returns
number
Parameters
port:
number
Returns
Uri
port
Part
port
Part
(
)
:
string
port
Part
(
port
:
string
)
:
Uri
Returns
string
Parameters
port:
string
Returns
Uri
prepended
Path
prepended
Path
(
...
components
:
AnyUriPath
[]
)
:
Uri
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
Uri
prepended
Query
prepended
Query
(
key
:
string
|
null
, value
:
string
)
:
Uri
prepended
Query
(
params
:
AnyUriQuery
)
:
Uri
Parameters
key:
string
|
null
value:
string
Returns
Uri
Parameters
params:
AnyUriQuery
Returns
Uri
prepended
Segment
prepended
Segment
(
segment
:
string
)
:
Uri
Parameters
segment:
string
Returns
Uri
prepended
Slash
prepended
Slash
(
)
:
Uri
Returns
Uri
query
query
(
)
:
UriQuery
query
(
query
:
AnyUriQuery
)
:
Uri
Returns
UriQuery
Parameters
query:
AnyUriQuery
Returns
Uri
query
Part
query
Part
(
)
:
string
query
Part
(
query
:
string
)
:
Uri
Returns
string
Parameters
query:
string
Returns
Uri
removed
Query
removed
Query
(
key
:
string
)
:
Uri
Parameters
key:
string
Returns
Uri
resolve
resolve
(
relative
:
AnyUri
)
:
Uri
Parameters
relative:
AnyUri
Returns
Uri
scheme
scheme
(
)
:
UriScheme
scheme
(
scheme
:
AnyUriScheme
)
:
Uri
Returns
UriScheme
Parameters
scheme:
AnyUriScheme
Returns
Uri
scheme
Name
scheme
Name
(
)
:
string
scheme
Name
(
scheme
:
string
)
:
Uri
Returns
string
Parameters
scheme:
string
Returns
Uri
scheme
Part
scheme
Part
(
)
:
string
scheme
Part
(
scheme
:
string
)
:
Uri
Returns
string
Parameters
scheme:
string
Returns
Uri
to
Any
to
Any
(
)
:
object
Returns
object
to
String
to
String
(
)
:
string
Returns
string
unresolve
unresolve
(
absolute
:
AnyUri
)
:
Uri
Parameters
absolute:
AnyUri
Returns
Uri
updated
Query
updated
Query
(
key
:
string
, value
:
string
)
:
Uri
Parameters
key:
string
value:
string
Returns
Uri
user
user
(
)
:
UriUser
user
(
user
:
AnyUriUser
)
:
Uri
Returns
UriUser
Parameters
user:
AnyUriUser
Returns
Uri
user
Part
user
Part
(
)
:
string
user
Part
(
user
:
string
)
:
Uri
Returns
string
Parameters
user:
string
Returns
Uri
username
username
(
)
:
string
username
(
username
:
string
, password
?:
string
|
null
)
:
Uri
Returns
string
Parameters
username:
string
Optional
password:
string
|
null
Returns
Uri
Static
authority
authority
(
authority
:
AnyUriAuthority
)
:
Uri
Parameters
authority:
AnyUriAuthority
Returns
Uri
Static
authority
Part
authority
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
empty
empty
(
)
:
Uri
Returns
Uri
Static
form
form
(
)
:
Form
<
Uri
>
Returns
Form
<
Uri
>
Static
fragment
fragment
(
fragment
:
AnyUriFragment
)
:
Uri
Parameters
fragment:
AnyUriFragment
Returns
Uri
Static
fragment
Identifier
fragment
Identifier
(
identifier
:
string
)
:
Uri
Parameters
identifier:
string
Returns
Uri
Static
fragment
Part
fragment
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
from
from
(
scheme
?:
UriScheme
, authority
?:
UriAuthority
, path
?:
UriPath
, query
?:
UriQuery
, fragment
?:
UriFragment
)
:
Uri
Parameters
Default value
scheme:
UriScheme
= Uri.Scheme.undefined()
Default value
authority:
UriAuthority
= Uri.Authority.undefined()
Default value
path:
UriPath
= Uri.Path.empty()
Default value
query:
UriQuery
= Uri.Query.undefined()
Default value
fragment:
UriFragment
= Uri.Fragment.undefined()
Returns
Uri
Static
from
Any
from
Any
(
uri
:
AnyUri
|
null
|
undefined
)
:
Uri
Parameters
uri:
AnyUri
|
null
|
undefined
Returns
Uri
Static
host
host
(
host
:
AnyUriHost
)
:
Uri
Parameters
host:
AnyUriHost
Returns
Uri
Static
hostIPv4
hostIPv4
(
address
:
string
)
:
Uri
Parameters
address:
string
Returns
Uri
Static
hostIPv6
hostIPv6
(
address
:
string
)
:
Uri
Parameters
address:
string
Returns
Uri
Static
host
Name
host
Name
(
address
:
string
)
:
Uri
Parameters
address:
string
Returns
Uri
Static
host
Part
host
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
parse
parse
(
string
:
string
)
:
Uri
Parameters
string:
string
Returns
Uri
Static
password
password
(
password
:
string
)
:
Uri
Parameters
password:
string
Returns
Uri
Static
path
path
(
...
components
:
AnyUriPath
[]
)
:
Uri
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
Uri
Static
path
Part
path
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
port
port
(
port
:
AnyUriPort
)
:
Uri
Parameters
port:
AnyUriPort
Returns
Uri
Static
port
Number
port
Number
(
number
:
number
)
:
Uri
Parameters
number:
number
Returns
Uri
Static
port
Part
port
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
query
query
(
query
:
AnyUriQuery
)
:
Uri
Parameters
query:
AnyUriQuery
Returns
Uri
Static
query
Part
query
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
scheme
scheme
(
scheme
:
AnyUriScheme
)
:
Uri
Parameters
scheme:
AnyUriScheme
Returns
Uri
Static
scheme
Name
scheme
Name
(
name
:
string
)
:
Uri
Parameters
name:
string
Returns
Uri
Static
scheme
Part
scheme
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
standard
Parser
standard
Parser
(
)
:
UriParser
Returns
UriParser
Static
user
user
(
user
:
AnyUriUser
)
:
Uri
Parameters
user:
AnyUriUser
Returns
Uri
Static
user
Part
user
Part
(
part
:
string
)
:
Uri
Parameters
part:
string
Returns
Uri
Static
username
username
(
username
:
string
, password
?:
string
|
null
)
:
Uri
Parameters
username:
string
Optional
password:
string
|
null
Returns
Uri
Globals
@swim/core
@swim/codec
@swim/collections
@swim/dataflow
@swim/math
@swim/recon
@swim/streamlet
@swim/structure
@swim/time
@swim/uri
@swim/util
@swim/mesh
@swim/ui
@swim/ux
@swim/web
Uri
appended
Path
appended
Query
appended
Segment
appended
Slash
authority
authority
Part
base
base
Path
compare
To
copy
debug
display
endpoint
equals
fragment
fragment
Identifier
fragment
Part
hash
Code
host
host
Address
hostIPv4
hostIPv6
host
Name
host
Part
is
Defined
is
Empty
parent
parent
Path
password
path
path
Name
path
Part
port
port
Number
port
Part
prepended
Path
prepended
Query
prepended
Segment
prepended
Slash
query
query
Part
removed
Query
resolve
scheme
scheme
Name
scheme
Part
to
Any
to
String
unresolve
updated
Query
user
user
Part
username
authority
authority
Part
empty
form
fragment
fragment
Identifier
fragment
Part
from
from
Any
host
hostIPv4
hostIPv6
host
Name
host
Part
parse
password
path
path
Part
port
port
Number
port
Part
query
query
Part
scheme
scheme
Name
scheme
Part
standard
Parser
user
user
Part
username
Uri
Authority
Uri
Cache
Uri
Exception
Uri
Fragment
Uri
Host
Uri
Parser
Uri
Path
Uri
Path
Builder
Uri
Port
Uri
Query
Uri
Query
Builder
Uri
Scheme
Uri
User
Uri
Authority
Init
Uri
Init
Uri
User
Init
Any
Uri
Any
Uri
Authority
Any
Uri
Fragment
Any
Uri
Host
Any
Uri
Path
Any
Uri
Port
Any
Uri
Query
Any
Uri
Scheme
Any
Uri
User