Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/structure
Item
Class Item
Hierarchy
Item
Implements
Interpolate
<
Item
>
HashCode
Equivalent
Compare
Debug
Display
Index
Constructors
constructor
Properties
key
length
tag
target
type
Order
Accessors
precedence
Methods
alias
and
appended
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clone
coerce
commit
compare
To
concat
conditional
debug
deleted
display
divide
eq
equals
equivalent
To
evaluate
filter
flattened
for
Each
ge
get
get
Attr
get
Field
get
Item
get
Slot
gt
has
hash
Code
head
header
headers
interpolate
To
inverse
invoke
is
Aliased
is
Constant
is
Defined
is
Definite
is
Distinct
is
Mutable
iterator
key
Equals
lambda
le
lt
max
min
minus
modulo
ne
negative
not
number
Value
or
plus
positive
prepended
string
Value
substitute
tail
times
to
Any
to
Recon
to
Recon
Block
to
String
to
Value
unflattened
updated
updated
Attr
updated
Slot
absent
empty
extant
from
Any
global
Scope
Constructors
constructor
new
Item
(
)
:
Item
Returns
Item
Properties
Readonly
Abstract
key
key
:
Value
Readonly
Abstract
length
length
:
number
Readonly
Abstract
tag
tag
:
undefined
|
string
Readonly
Abstract
target
target
:
Value
Readonly
Abstract
type
Order
type
Order
:
number
Accessors
precedence
get
precedence
(
)
:
number
Returns
number
Methods
Abstract
alias
alias
(
)
:
void
Returns
void
Abstract
and
and
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
appended
appended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
Abstract
bitwise
And
bitwise
And
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
bitwise
Not
bitwise
Not
(
)
:
Item
Returns
Item
Abstract
bitwise
Or
bitwise
Or
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
bitwise
Xor
bitwise
Xor
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
body
body
(
)
:
Value
Returns
Value
Abstract
boolean
Value
boolean
Value
(
)
:
undefined
|
boolean
boolean
Value<T>
(
orElse
:
T
)
:
boolean
|
T
Returns
undefined
|
boolean
Type parameters
T
Parameters
orElse:
T
Returns
boolean
|
T
Abstract
branch
branch
(
)
:
Item
Returns
Item
cast
cast<T>
(
form
:
Form
<
T
,
unknown
>
)
:
undefined
|
T
cast<T, E>
(
form
:
Form
<
T
,
unknown
>
, orElse
:
E
)
:
T
|
E
Type parameters
T
Parameters
form:
Form
<
T
,
unknown
>
Returns
undefined
|
T
Type parameters
T
E =
T
Parameters
form:
Form
<
T
,
unknown
>
orElse:
E
Returns
T
|
E
Abstract
clone
clone
(
)
:
Item
Returns
Item
coerce
coerce<T>
(
form
:
Form
<
T
,
unknown
>
)
:
T
coerce<T, E>
(
form
:
Form
<
T
,
unknown
>
, orElse
:
E
)
:
T
|
E
Type parameters
T
Parameters
form:
Form
<
T
,
unknown
>
Returns
T
Type parameters
T
E =
T
Parameters
form:
Form
<
T
,
unknown
>
orElse:
E
Returns
T
|
E
Abstract
commit
commit
(
)
:
Item
Returns
Item
Abstract
compare
To
compare
To
(
that
:
unknown
)
:
number
Parameters
that:
unknown
Returns
number
concat
concat
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
Abstract
conditional
conditional
(
thenTerm
:
Item
, elseTerm
:
Item
)
:
Item
Parameters
thenTerm:
Item
elseTerm:
Item
Returns
Item
Abstract
debug
debug
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
Abstract
deleted
deleted
(
key
:
AnyValue
)
:
Item
Parameters
key:
AnyValue
Returns
Item
display
display
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
Abstract
divide
divide
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
eq
eq
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
equals
equals
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
Abstract
equivalent
To
equivalent
To
(
that
:
unknown
, epsilon
?:
number
)
:
boolean
Parameters
that:
unknown
Optional
epsilon:
number
Returns
boolean
evaluate
evaluate
(
interpreter
:
AnyInterpreter
)
:
Item
Parameters
interpreter:
AnyInterpreter
Returns
Item
filter
filter
(
predicate
?:
AnyItem
)
:
Selector
Parameters
Optional
predicate:
AnyItem
Returns
Selector
Abstract
flattened
flattened
(
)
:
Value
Returns
Value
for
Each
for
Each<T>
(
callback
:
(
item
:
Item
, index
:
number
)
=>
void
|
T
)
:
undefined
|
T
for
Each<T, S>
(
callback
:
(
item
:
Item
, index
:
number
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
Type parameters
T
Parameters
callback:
(
item
:
Item
, index
:
number
)
=>
void
|
T
(
item
:
Item
, index
:
number
)
:
void
|
T
Parameters
item:
Item
index:
number
Returns
void
|
T
Returns
undefined
|
T
Type parameters
T
S
Parameters
callback:
(
item
:
Item
, index
:
number
)
=>
void
|
T
(
item
:
Item
, index
:
number
)
:
void
|
T
Parameters
item:
Item
index:
number
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
ge
ge
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
get
get
(
key
:
AnyValue
)
:
Value
Parameters
key:
AnyValue
Returns
Value
Abstract
get
Attr
get
Attr
(
key
:
AnyText
)
:
Value
Parameters
key:
AnyText
Returns
Value
Abstract
get
Field
get
Field
(
key
:
AnyValue
)
:
undefined
|
Field
Parameters
key:
AnyValue
Returns
undefined
|
Field
Abstract
get
Item
get
Item
(
index
:
AnyNum
)
:
Item
Parameters
index:
AnyNum
Returns
Item
Abstract
get
Slot
get
Slot
(
key
:
AnyValue
)
:
Value
Parameters
key:
AnyValue
Returns
Value
gt
gt
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
has
has
(
key
:
AnyValue
)
:
boolean
Parameters
key:
AnyValue
Returns
boolean
Abstract
hash
Code
hash
Code
(
)
:
number
Returns
number
Abstract
head
head
(
)
:
Item
Returns
Item
Abstract
header
header
(
tag
:
string
)
:
Value
Parameters
tag:
string
Returns
Value
Abstract
headers
headers
(
tag
:
string
)
:
undefined
|
Record
Parameters
tag:
string
Returns
undefined
|
Record
interpolate
To
interpolate
To
(
that
:
Item
)
:
Interpolator
<
Item
>
interpolate
To
(
that
:
unknown
)
:
null
|
Interpolator
<
Item
>
Parameters
that:
Item
Returns
Interpolator
<
Item
>
Parameters
that:
unknown
Returns
null
|
Interpolator
<
Item
>
Abstract
inverse
inverse
(
)
:
Item
Returns
Item
invoke
invoke
(
args
:
Value
)
:
Item
Parameters
args:
Value
Returns
Item
Abstract
is
Aliased
is
Aliased
(
)
:
boolean
Returns
boolean
Abstract
is
Constant
is
Constant
(
)
:
boolean
Returns
boolean
Abstract
is
Defined
is
Defined
(
)
:
boolean
Returns
boolean
Abstract
is
Definite
is
Definite
(
)
:
boolean
Returns
boolean
Abstract
is
Distinct
is
Distinct
(
)
:
boolean
Returns
boolean
Abstract
is
Mutable
is
Mutable
(
)
:
boolean
Returns
boolean
iterator
iterator
(
)
:
Cursor
<
Item
>
Returns
Cursor
<
Item
>
Abstract
key
Equals
key
Equals
(
key
:
unknown
)
:
boolean
Parameters
key:
unknown
Returns
boolean
Abstract
lambda
lambda
(
template
:
Value
)
:
Value
Parameters
template:
Value
Returns
Value
le
le
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
lt
lt
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
max
max
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
min
min
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
Abstract
minus
minus
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
modulo
modulo
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
ne
ne
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
negative
negative
(
)
:
Item
Returns
Item
Abstract
not
not
(
)
:
Item
Returns
Item
Abstract
number
Value
number
Value
(
)
:
undefined
|
number
number
Value<T>
(
orElse
:
T
)
:
number
|
T
Returns
undefined
|
number
Type parameters
T
Parameters
orElse:
T
Returns
number
|
T
Abstract
or
or
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
Abstract
plus
plus
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
positive
positive
(
)
:
Item
Returns
Item
prepended
prepended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
Abstract
string
Value
string
Value
(
)
:
undefined
|
string
string
Value<T>
(
orElse
:
T
)
:
string
|
T
Returns
undefined
|
string
Type parameters
T
Parameters
orElse:
T
Returns
string
|
T
substitute
substitute
(
interpreter
:
AnyInterpreter
)
:
Item
Parameters
interpreter:
AnyInterpreter
Returns
Item
Abstract
tail
tail
(
)
:
Record
Returns
Record
Abstract
times
times
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyItem
Returns
Item
Abstract
to
Any
to
Any
(
)
:
AnyItem
Returns
AnyItem
to
Recon
to
Recon
(
)
:
string
Returns
string
to
Recon
Block
to
Recon
Block
(
)
:
string
Returns
string
to
String
to
String
(
)
:
string
Returns
string
Abstract
to
Value
to
Value
(
)
:
Value
Returns
Value
Abstract
unflattened
unflattened
(
)
:
Record
Returns
Record
updated
updated
(
key
:
AnyValue
, value
:
AnyValue
)
:
Record
Parameters
key:
AnyValue
value:
AnyValue
Returns
Record
updated
Attr
updated
Attr
(
key
:
AnyText
, value
:
AnyValue
)
:
Record
Parameters
key:
AnyText
value:
AnyValue
Returns
Record
updated
Slot
updated
Slot
(
key
:
AnyValue
, value
:
AnyValue
)
:
Record
Parameters
key:
AnyValue
value:
AnyValue
Returns
Record
Static
absent
absent
(
)
:
Item
Returns
Item
Static
empty
empty
(
)
:
Item
Returns
Item
Static
extant
extant
(
)
:
Item
Returns
Item
Static
from
Any
from
Any
(
item
:
AnyItem
)
:
Item
Parameters
item:
AnyItem
Returns
Item
Static
global
Scope
global
Scope
(
)
:
Item
Returns
Item
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
Item
constructor
key
length
tag
target
type
Order
precedence
alias
and
appended
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clone
coerce
commit
compare
To
concat
conditional
debug
deleted
display
divide
eq
equals
equivalent
To
evaluate
filter
flattened
for
Each
ge
get
get
Attr
get
Field
get
Item
get
Slot
gt
has
hash
Code
head
header
headers
interpolate
To
inverse
invoke
is
Aliased
is
Constant
is
Defined
is
Definite
is
Distinct
is
Mutable
iterator
key
Equals
lambda
le
lt
max
min
minus
modulo
ne
negative
not
number
Value
or
plus
positive
prepended
string
Value
substitute
tail
times
to
Any
to
Recon
to
Recon
Block
to
String
to
Value
unflattened
updated
updated
Attr
updated
Slot
absent
empty
extant
from
Any
global
Scope
Generated using
TypeDoc