Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/uri
UriPathSegment
Class UriPathSegment
Hierarchy
UriPath
UriPathSegment
Index
Constructors
constructor
Properties
rest
segment
string
Value
Accessors
length
name
segment
Cache
Methods
appended
appended
Segment
appended
Slash
base
compare
To
dealias
debug
display
equals
foot
get
hash
Code
head
is
Absolute
is
Defined
is
Empty
is
Relative
is
Subpath
Of
merge
parent
prepended
prepended
Segment
prepended
Slash
remove
Dot
Segments
resolve
set
Tail
tail
to
Any
to
String
unmerge
with
Name
builder
cache
Segment
empty
from
Any
of
parse
path
Form
segment
slash
Constructors
constructor
new
Uri
Path
Segment
(
head
:
string
, tail
:
UriPath
)
:
UriPathSegment
Parameters
head:
string
tail:
UriPath
Returns
UriPathSegment
Properties
Readonly
rest
rest
:
UriPath
Readonly
segment
segment
:
string
Readonly
string
Value
string
Value
:
undefined
|
string
Accessors
length
get
length
(
)
:
number
Returns
number
name
get
name
(
)
:
string
Returns
string
Static
segment
Cache
get
segmentCache
(
)
:
HashGenCacheSet
<
string
>
Returns
HashGenCacheSet
<
string
>
Methods
appended
appended
(
...
components
:
AnyUriPath
[]
)
:
UriPath
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
UriPath
appended
Segment
appended
Segment
(
segment
:
string
)
:
UriPath
Parameters
segment:
string
Returns
UriPath
appended
Slash
appended
Slash
(
)
:
UriPath
Returns
UriPath
base
base
(
)
:
UriPath
Returns
UriPath
compare
To
compare
To
(
that
:
unknown
)
:
number
Parameters
that:
unknown
Returns
number
dealias
dealias
(
)
:
UriPath
Returns
UriPath
debug
debug
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
display
display
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
equals
equals
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
foot
foot
(
)
:
UriPath
Returns
UriPath
get
get
(
index
:
number
)
:
undefined
|
string
Parameters
index:
number
Returns
undefined
|
string
hash
Code
hash
Code
(
)
:
number
Returns
number
head
head
(
)
:
string
Returns
string
is
Absolute
is
Absolute
(
)
:
boolean
Returns
boolean
is
Defined
is
Defined
(
)
:
boolean
Returns
boolean
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
is
Relative
is
Relative
(
)
:
boolean
Returns
boolean
is
Subpath
Of
is
Subpath
Of
(
b
:
AnyUriPath
)
:
boolean
Parameters
b:
AnyUriPath
Returns
boolean
merge
merge
(
that
:
UriPath
)
:
UriPath
Parameters
that:
UriPath
Returns
UriPath
parent
parent
(
)
:
UriPath
Returns
UriPath
prepended
prepended
(
...
components
:
AnyUriPath
[]
)
:
UriPath
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
UriPath
prepended
Segment
prepended
Segment
(
segment
:
string
)
:
UriPath
Parameters
segment:
string
Returns
UriPath
prepended
Slash
prepended
Slash
(
)
:
UriPath
Returns
UriPath
remove
Dot
Segments
remove
Dot
Segments
(
)
:
UriPath
Returns
UriPath
resolve
resolve
(
that
:
UriPath
)
:
UriPath
Parameters
that:
UriPath
Returns
UriPath
set
Tail
set
Tail
(
tail
:
UriPath
)
:
void
Parameters
tail:
UriPath
Returns
void
tail
tail
(
)
:
UriPath
Returns
UriPath
to
Any
to
Any
(
)
:
string
[]
Returns
string
[]
to
String
to
String
(
)
:
string
Returns
string
unmerge
unmerge
(
relative
:
UriPath
, root
?:
UriPath
)
:
UriPath
Parameters
relative:
UriPath
Optional
root:
UriPath
Returns
UriPath
with
Name
with
Name
(
name
:
string
)
:
UriPath
Parameters
name:
string
Returns
UriPath
Static
builder
builder
(
)
:
UriPathBuilder
Returns
UriPathBuilder
Static
cache
Segment
cache
Segment
(
segment
:
string
)
:
string
Parameters
segment:
string
Returns
string
Static
empty
empty
(
)
:
UriPath
Returns
UriPath
Static
from
Any
from
Any
(
value
:
undefined
|
null
|
AnyUriPath
)
:
UriPath
Parameters
value:
undefined
|
null
|
AnyUriPath
Returns
UriPath
Static
of
of
(
...
components
:
AnyUriPath
[]
)
:
UriPath
Parameters
Rest
...
components:
AnyUriPath
[]
Returns
UriPath
Static
parse
parse
(
pathPart
:
string
)
:
UriPath
Parameters
pathPart:
string
Returns
UriPath
Static
path
Form
path
Form
(
)
:
Form
<
UriPath
,
AnyUriPath
>
Returns
Form
<
UriPath
,
AnyUriPath
>
Static
segment
segment
(
segment
:
string
, tail
?:
UriPath
)
:
UriPath
Parameters
segment:
string
Optional
tail:
UriPath
Returns
UriPath
Static
slash
slash
(
)
:
UriPath
Returns
UriPath
Modules
@swim/system
@swim/core
@swim/util
@swim/codec
@swim/mapping
@swim/collections
@swim/constraint
@swim/structure
@swim/streamlet
@swim/dataflow
@swim/recon
@swim/uri
@swim/math
@swim/geo
@swim/time
@swim/mesh
@swim/toolkit
Uri
Path
Segment
constructor
rest
segment
string
Value
length
name
segment
Cache
appended
appended
Segment
appended
Slash
base
compare
To
dealias
debug
display
equals
foot
get
hash
Code
head
is
Absolute
is
Defined
is
Empty
is
Relative
is
Subpath
Of
merge
parent
prepended
prepended
Segment
prepended
Slash
remove
Dot
Segments
resolve
set
Tail
tail
to
Any
to
String
unmerge
with
Name
builder
cache
Segment
empty
from
Any
of
parse
path
Form
segment
slash
Generated using
TypeDoc