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
Data
Class Data
Hierarchy
Value
Data
Index
Constructors
constructor
Properties
array
flags
size
Aliased
Flag
Immutable
Flag
Accessors
key
length
precedence
tag
target
type
Order
Methods
add
Byte
add
Byte
Aliased
add
Byte
Mutable
add
Data
add
Uint8
Array
add
Uint8
Array
Aliased
add
Uint8
Array
Mutable
alias
and
appended
as
Uint8
Array
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clear
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
Byte
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
set
Byte
set
Byte
Aliased
set
Byte
Mutable
string
Value
substitute
tail
times
to
Any
to
Base16
to
Base64
to
Recon
to
Recon
Block
to
String
to
Uint8
Array
to
Value
unflattened
updated
updated
Attr
updated
Slot
write
Base16
write
Base64
absent
builder
create
empty
expand
extant
from
Any
from
Base16
from
Base64
global
Scope
output
random
wrap
Constructors
constructor
new
Data
(
array
:
null
|
Uint8Array
, size
:
number
, flags
:
number
)
:
Data
Parameters
array:
null
|
Uint8Array
size:
number
flags:
number
Returns
Data
Properties
Readonly
array
array
:
null
|
Uint8Array
Readonly
flags
flags
:
number
Readonly
size
size
:
number
Static
Readonly
Aliased
Flag
Aliased
Flag
:
number
Static
Readonly
Immutable
Flag
Immutable
Flag
:
number
Accessors
key
get
key
(
)
:
Value
Returns
Value
length
get
length
(
)
:
number
Returns
number
precedence
get
precedence
(
)
:
number
Returns
number
tag
get
tag
(
)
:
undefined
|
string
Returns
undefined
|
string
target
get
target
(
)
:
Value
Returns
Value
type
Order
get
typeOrder
(
)
:
number
Returns
number
Methods
add
Byte
add
Byte
(
value
:
number
)
:
Data
Parameters
value:
number
Returns
Data
add
Byte
Aliased
add
Byte
Aliased
(
value
:
number
)
:
Data
Parameters
value:
number
Returns
Data
add
Byte
Mutable
add
Byte
Mutable
(
value
:
number
)
:
Data
Parameters
value:
number
Returns
Data
add
Data
add
Data
(
data
:
Data
)
:
Data
Parameters
data:
Data
Returns
Data
add
Uint8
Array
add
Uint8
Array
(
array
:
Uint8Array
)
:
Data
Parameters
array:
Uint8Array
Returns
Data
add
Uint8
Array
Aliased
add
Uint8
Array
Aliased
(
array
:
Uint8Array
)
:
Data
Parameters
array:
Uint8Array
Returns
Data
add
Uint8
Array
Mutable
add
Uint8
Array
Mutable
(
array
:
Uint8Array
)
:
Data
Parameters
array:
Uint8Array
Returns
Data
alias
alias
(
)
:
void
Returns
void
and
and
(
that
:
AnyValue
)
:
Value
and
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
appended
appended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
as
Uint8
Array
as
Uint8
Array
(
)
:
undefined
|
Uint8Array
Returns
undefined
|
Uint8Array
bitwise
And
bitwise
And
(
that
:
AnyValue
)
:
Value
bitwise
And
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
bitwise
Not
bitwise
Not
(
)
:
Value
Returns
Value
bitwise
Or
bitwise
Or
(
that
:
AnyValue
)
:
Value
bitwise
Or
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
bitwise
Xor
bitwise
Xor
(
that
:
AnyValue
)
:
Value
bitwise
Xor
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
body
body
(
)
:
Value
Returns
Value
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
branch
branch
(
)
:
Data
Returns
Data
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
clear
clear
(
)
:
void
Returns
void
clone
clone
(
)
:
Data
Returns
Data
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
commit
commit
(
)
:
Data
Returns
Data
compare
To
compare
To
(
that
:
unknown
)
:
number
Parameters
that:
unknown
Returns
number
concat
concat
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
conditional
conditional
(
thenTerm
:
AnyValue
, elseTerm
:
AnyValue
)
:
Value
conditional
(
thenTerm
:
AnyItem
, elseTerm
:
AnyItem
)
:
Item
Parameters
thenTerm:
AnyValue
elseTerm:
AnyValue
Returns
Value
Parameters
thenTerm:
AnyItem
elseTerm:
AnyItem
Returns
Item
debug
debug
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
deleted
deleted
(
key
:
AnyValue
)
:
Value
Parameters
key:
AnyValue
Returns
Value
display
display
(
output
:
Output
<
unknown
>
)
:
void
Parameters
output:
Output
<
unknown
>
Returns
void
divide
divide
(
that
:
AnyValue
)
:
Value
divide
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
eq
eq
(
that
:
AnyValue
)
:
Value
eq
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
equals
equals
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
equivalent
To
equivalent
To
(
that
:
Item
)
:
boolean
Parameters
that:
Item
Returns
boolean
evaluate
evaluate
(
interpreter
:
AnyInterpreter
)
:
Item
Parameters
interpreter:
AnyInterpreter
Returns
Item
filter
filter
(
predicate
?:
AnyItem
)
:
Selector
Parameters
Optional
predicate:
AnyItem
Returns
Selector
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
:
AnyValue
)
:
Value
ge
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
get
get
(
key
:
AnyValue
)
:
Value
Parameters
key:
AnyValue
Returns
Value
get
Attr
get
Attr
(
key
:
AnyText
)
:
Value
Parameters
key:
AnyText
Returns
Value
get
Byte
get
Byte
(
index
:
number
)
:
number
Parameters
index:
number
Returns
number
get
Field
get
Field
(
key
:
AnyValue
)
:
undefined
|
Field
Parameters
key:
AnyValue
Returns
undefined
|
Field
get
Item
get
Item
(
index
:
AnyNum
)
:
Item
Parameters
index:
AnyNum
Returns
Item
get
Slot
get
Slot
(
key
:
AnyValue
)
:
Value
Parameters
key:
AnyValue
Returns
Value
gt
gt
(
that
:
AnyValue
)
:
Value
gt
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
has
has
(
key
:
AnyValue
)
:
boolean
Parameters
key:
AnyValue
Returns
boolean
hash
Code
hash
Code
(
)
:
number
Returns
number
head
head
(
)
:
Item
Returns
Item
header
header
(
tag
:
string
)
:
Value
Parameters
tag:
string
Returns
Value
headers
headers
(
tag
:
string
)
:
undefined
|
Record
Parameters
tag:
string
Returns
undefined
|
Record
interpolate
To
interpolate
To
(
that
:
Data
)
:
Interpolator
<
Data
>
interpolate
To
(
that
:
Item
)
:
Interpolator
<
Item
>
interpolate
To
(
that
:
unknown
)
:
null
|
Interpolator
<
Item
>
Parameters
that:
Data
Returns
Interpolator
<
Data
>
Parameters
that:
Item
Returns
Interpolator
<
Item
>
Parameters
that:
unknown
Returns
null
|
Interpolator
<
Item
>
inverse
inverse
(
)
:
Value
Returns
Value
invoke
invoke
(
args
:
Value
)
:
Item
Parameters
args:
Value
Returns
Item
is
Aliased
is
Aliased
(
)
:
boolean
Returns
boolean
is
Constant
is
Constant
(
)
:
boolean
Returns
boolean
is
Defined
is
Defined
(
)
:
boolean
Returns
boolean
is
Definite
is
Definite
(
)
:
boolean
Returns
boolean
is
Distinct
is
Distinct
(
)
:
boolean
Returns
boolean
is
Mutable
is
Mutable
(
)
:
boolean
Returns
boolean
iterator
iterator
(
)
:
Cursor
<
Item
>
Returns
Cursor
<
Item
>
key
Equals
key
Equals
(
key
:
unknown
)
:
boolean
Parameters
key:
unknown
Returns
boolean
lambda
lambda
(
template
:
Value
)
:
Value
Parameters
template:
Value
Returns
Value
le
le
(
that
:
AnyValue
)
:
Value
le
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
lt
lt
(
that
:
AnyValue
)
:
Value
lt
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
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
minus
minus
(
that
:
AnyValue
)
:
Value
minus
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
modulo
modulo
(
that
:
AnyValue
)
:
Value
modulo
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
ne
ne
(
that
:
AnyValue
)
:
Value
ne
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
negative
negative
(
)
:
Value
Returns
Value
not
not
(
)
:
Value
Returns
Value
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
or
or
(
that
:
AnyValue
)
:
Value
or
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
plus
plus
(
that
:
AnyValue
)
:
Value
plus
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
positive
positive
(
)
:
Value
Returns
Value
prepended
prepended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
set
Byte
set
Byte
(
index
:
number
, value
:
number
)
:
Data
Parameters
index:
number
value:
number
Returns
Data
set
Byte
Aliased
set
Byte
Aliased
(
index
:
number
, value
:
number
)
:
Data
Parameters
index:
number
value:
number
Returns
Data
set
Byte
Mutable
set
Byte
Mutable
(
index
:
number
, value
:
number
)
:
Data
Parameters
index:
number
value:
number
Returns
Data
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
tail
tail
(
)
:
Record
Returns
Record
times
times
(
that
:
AnyValue
)
:
Value
times
(
that
:
AnyItem
)
:
Item
Parameters
that:
AnyValue
Returns
Value
Parameters
that:
AnyItem
Returns
Item
to
Any
to
Any
(
)
:
AnyData
Returns
AnyData
to
Base16
to
Base16
(
base16
?:
Base16
)
:
string
Parameters
Optional
base16:
Base16
Returns
string
to
Base64
to
Base64
(
base64
?:
Base64
)
:
string
Parameters
Optional
base64:
Base64
Returns
string
to
Recon
to
Recon
(
)
:
string
Returns
string
to
Recon
Block
to
Recon
Block
(
)
:
string
Returns
string
to
String
to
String
(
)
:
string
Returns
string
to
Uint8
Array
to
Uint8
Array
(
)
:
Uint8Array
Returns
Uint8Array
to
Value
to
Value
(
)
:
Value
Returns
Value
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
write
Base16
write
Base16
(
output
:
Output
<
unknown
>
, base16
?:
Base16
)
:
Writer
<
unknown
,
unknown
>
Parameters
output:
Output
<
unknown
>
Optional
base16:
Base16
Returns
Writer
<
unknown
,
unknown
>
write
Base64
write
Base64
(
output
:
Output
<
unknown
>
, base64
?:
Base64
)
:
Writer
<
unknown
,
unknown
>
Parameters
output:
Output
<
unknown
>
Optional
base64:
Base64
Returns
Writer
<
unknown
,
unknown
>
Static
absent
absent
(
)
:
Value
Returns
Value
Static
builder
builder
(
)
:
Builder
<
Item
,
Value
>
Returns
Builder
<
Item
,
Value
>
Static
create
create
(
initialCapacity
?:
number
)
:
Data
Parameters
Optional
initialCapacity:
number
Returns
Data
Static
empty
empty
(
)
:
Data
Returns
Data
Static
expand
expand
(
n
:
number
)
:
number
Parameters
n:
number
Returns
number
Static
extant
extant
(
)
:
Value
Returns
Value
Static
from
Any
from
Any
(
value
:
AnyData
)
:
Data
Parameters
value:
AnyData
Returns
Data
Static
from
Base16
from
Base16
(
input
:
string
|
Input
)
:
Data
Parameters
input:
string
|
Input
Returns
Data
Static
from
Base64
from
Base64
(
input
:
string
|
Input
, base64
?:
Base64
)
:
Data
Parameters
input:
string
|
Input
Optional
base64:
Base64
Returns
Data
Static
global
Scope
global
Scope
(
)
:
Item
Returns
Item
Static
output
output
(
)
:
Output
<
Data
>
output
(
initialCapacity
:
number
)
:
Output
<
Data
>
output
(
data
:
Data
)
:
Output
<
Data
>
Returns
Output
<
Data
>
Parameters
initialCapacity:
number
Returns
Output
<
Data
>
Parameters
data:
Data
Returns
Output
<
Data
>
Static
random
random
(
size
:
number
)
:
Data
Parameters
size:
number
Returns
Data
Static
wrap
wrap
(
value
:
Uint8Array
)
:
Data
Parameters
value:
Uint8Array
Returns
Data
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
Data
constructor
array
flags
size
Aliased
Flag
Immutable
Flag
key
length
precedence
tag
target
type
Order
add
Byte
add
Byte
Aliased
add
Byte
Mutable
add
Data
add
Uint8
Array
add
Uint8
Array
Aliased
add
Uint8
Array
Mutable
alias
and
appended
as
Uint8
Array
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clear
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
Byte
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
set
Byte
set
Byte
Aliased
set
Byte
Mutable
string
Value
substitute
tail
times
to
Any
to
Base16
to
Base64
to
Recon
to
Recon
Block
to
String
to
Uint8
Array
to
Value
unflattened
updated
updated
Attr
updated
Slot
write
Base16
write
Base64
absent
builder
create
empty
expand
extant
from
Any
from
Base16
from
Base64
global
Scope
output
random
wrap
Generated using
TypeDoc