Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/dataflow
RecordStreamlet
Class RecordStreamlet<I, O>
Type parameters
I
:
Value
=
Value
O
:
Value
=
I
Hierarchy
Record
RecordStreamlet
AbstractRecordStreamlet
Implements
Streamlet
<
I
,
O
>
Index
Constructors
constructor
Properties
field
Count
streamlet
Context
streamlet
Scope
Aliased
Flag
Immutable
Flag
Accessors
key
length
precedence
tag
target
type
Order
value
Count
Methods
alias
and
appended
attr
bind
bind
Input
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clear
clone
coerce
commit
compare
To
compile
compile
Inlet
concat
conditional
debug
decohere
delete
deleted
disconnect
Inputs
disconnect
Outputs
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
index
Of
inlet
interpolate
To
inverse
invoke
is
Aliased
is
Array
is
Constant
is
Defined
is
Definite
is
Distinct
is
Empty
is
Mutable
is
Object
item
items
iterator
key
Equals
lambda
last
Index
Of
le
lt
max
min
minus
modulo
ne
negative
not
number
Value
or
outlet
plus
positive
prepended
push
recohere
set
set
Attr
set
Item
set
Slot
set
Streamlet
Context
set
Streamlet
Scope
slice
slot
splice
string
Value
sub
Record
substitute
tail
times
to
Any
to
Array
to
Object
to
Recon
to
Recon
Block
to
String
to
Value
unbind
Input
unflattened
updated
updated
Attr
updated
Slot
absent
builder
create
empty
expand
extant
from
Any
from
Array
from
Object
global
Scope
of
Constructors
constructor
new
Record
Streamlet<I, O>
(
)
:
RecordStreamlet
<
I
,
O
>
Type parameters
I
:
Value
<
I
>
=
Value
O
:
Value
<
O
>
=
I
Returns
RecordStreamlet
<
I
,
O
>
Properties
Readonly
field
Count
field
Count
:
number
Readonly
Abstract
streamlet
Context
streamlet
Context
:
null
|
StreamletContext
Readonly
Abstract
streamlet
Scope
streamlet
Scope
:
null
|
StreamletScope
<
O
>
Static
Readonly
Aliased
Flag
Aliased
Flag
:
number
Static
Readonly
Immutable
Flag
Immutable
Flag
:
number
Accessors
key
get
key
(
)
:
Value
Returns
Value
Abstract
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
value
Count
get
valueCount
(
)
:
number
Returns
number
Methods
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
attr
attr
(
key
:
AnyText
, value
?:
AnyValue
)
:
RecordStreamlet
<
I
,
O
>
Parameters
key:
AnyText
Optional
value:
AnyValue
Returns
RecordStreamlet
<
I
,
O
>
bind
bind
(
)
:
Record
Returns
Record
Abstract
bind
Input
bind
Input
(
key
:
string
, input
:
Outlet
<
I
>
)
:
void
Parameters
key:
string
input:
Outlet
<
I
>
Returns
void
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
(
)
:
Record
Returns
Record
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
clear
clear
(
)
:
void
Returns
void
clone
clone
(
)
:
Record
Returns
Record
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
(
)
:
RecordStreamlet
<
I
,
O
>
Returns
RecordStreamlet
<
I
,
O
>
compare
To
compare
To
(
that
:
unknown
)
:
number
Parameters
that:
unknown
Returns
number
compile
compile
(
)
:
void
Returns
void
compile
Inlet
compile
Inlet
(
inlet
:
Inlet
<
I
>
, name
:
string
)
:
void
Parameters
inlet:
Inlet
<
I
>
name:
string
Returns
void
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
Abstract
decohere
decohere
(
)
:
void
Returns
void
Abstract
delete
delete
(
key
:
AnyValue
)
:
Item
Parameters
key:
AnyValue
Returns
Item
deleted
deleted
(
key
:
AnyValue
)
:
Record
Parameters
key:
AnyValue
Returns
Record
Abstract
disconnect
Inputs
disconnect
Inputs
(
)
:
void
Returns
void
Abstract
disconnect
Outputs
disconnect
Outputs
(
)
:
void
Returns
void
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
:
unknown
, epsilon
?:
number
)
:
boolean
Parameters
that:
unknown
Optional
epsilon:
number
Returns
boolean
evaluate
evaluate
(
interpreter
:
AnyInterpreter
)
:
Record
Parameters
interpreter:
AnyInterpreter
Returns
Record
filter
filter
(
predicate
?:
AnyItem
)
:
Selector
Parameters
Optional
predicate:
AnyItem
Returns
Selector
flattened
flattened
(
)
:
Value
Returns
Value
Abstract
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
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
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
index
Of
index
Of
(
item
:
AnyItem
, index
?:
number
)
:
number
Parameters
item:
AnyItem
Optional
index:
number
Returns
number
Abstract
inlet
inlet
(
key
:
string
)
:
null
|
Inlet
<
I
>
Parameters
key:
string
Returns
null
|
Inlet
<
I
>
interpolate
To
interpolate
To
(
that
:
Record
)
:
Interpolator
<
Record
>
interpolate
To
(
that
:
Item
)
:
Interpolator
<
Item
>
interpolate
To
(
that
:
unknown
)
:
null
|
Interpolator
<
Item
>
Parameters
that:
Record
Returns
Interpolator
<
Record
>
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
Array
is
Array
(
)
:
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
Abstract
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
is
Mutable
is
Mutable
(
)
:
boolean
Returns
boolean
is
Object
is
Object
(
)
:
boolean
Returns
boolean
item
item
(
item
:
AnyItem
)
:
RecordStreamlet
<
I
,
O
>
Parameters
item:
AnyItem
Returns
RecordStreamlet
<
I
,
O
>
items
items
(
...
items
:
AnyItem
[]
)
:
RecordStreamlet
<
I
,
O
>
Parameters
Rest
...
items:
AnyItem
[]
Returns
RecordStreamlet
<
I
,
O
>
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
last
Index
Of
last
Index
Of
(
item
:
AnyItem
, index
?:
number
)
:
number
Parameters
item:
AnyItem
Optional
index:
number
Returns
number
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
Abstract
outlet
outlet
(
key
:
string
)
:
null
|
Outlet
<
O
>
Parameters
key:
string
Returns
null
|
Outlet
<
O
>
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
Abstract
push
push
(
...
items
:
AnyItem
[]
)
:
number
Parameters
Rest
...
items:
AnyItem
[]
Returns
number
Abstract
recohere
recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
set
set
(
key
:
AnyValue
, newValue
:
AnyValue
)
:
RecordStreamlet
<
I
,
O
>
Parameters
key:
AnyValue
newValue:
AnyValue
Returns
RecordStreamlet
<
I
,
O
>
set
Attr
set
Attr
(
key
:
AnyText
, newValue
:
AnyValue
)
:
RecordStreamlet
<
I
,
O
>
Parameters
key:
AnyText
newValue:
AnyValue
Returns
RecordStreamlet
<
I
,
O
>
Abstract
set
Item
set
Item
(
index
:
number
, item
:
AnyItem
)
:
RecordStreamlet
<
I
,
O
>
Parameters
index:
number
item:
AnyItem
Returns
RecordStreamlet
<
I
,
O
>
set
Slot
set
Slot
(
key
:
AnyValue
, newValue
:
AnyValue
)
:
RecordStreamlet
<
I
,
O
>
Parameters
key:
AnyValue
newValue:
AnyValue
Returns
RecordStreamlet
<
I
,
O
>
Abstract
set
Streamlet
Context
set
Streamlet
Context
(
context
:
null
|
StreamletContext
)
:
void
Parameters
context:
null
|
StreamletContext
Returns
void
Abstract
set
Streamlet
Scope
set
Streamlet
Scope
(
parent
:
null
|
StreamletScope
<
O
>
)
:
void
Parameters
parent:
null
|
StreamletScope
<
O
>
Returns
void
slice
slice
(
lower
?:
number
, upper
?:
number
)
:
Record
Parameters
Optional
lower:
number
Optional
upper:
number
Returns
Record
slot
slot
(
key
:
AnyValue
, value
?:
AnyValue
)
:
RecordStreamlet
<
I
,
O
>
Parameters
key:
AnyValue
Optional
value:
AnyValue
Returns
RecordStreamlet
<
I
,
O
>
Abstract
splice
splice
(
start
:
number
, deleteCount
?:
number
,
...
newItems
:
AnyItem
[]
)
:
Item
[]
Parameters
start:
number
Optional
deleteCount:
number
Rest
...
newItems:
AnyItem
[]
Returns
Item
[]
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
sub
Record
sub
Record
(
lower
?:
number
, upper
?:
number
)
:
Record
Parameters
Optional
lower:
number
Optional
upper:
number
Returns
Record
substitute
substitute
(
interpreter
:
AnyInterpreter
)
:
Record
Parameters
interpreter:
AnyInterpreter
Returns
Record
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
(
)
:
AnyValue
Returns
AnyValue
to
Array
to
Array
(
)
:
AnyItem
[]
Returns
AnyItem
[]
to
Object
to
Object
(
)
:
{}
Returns
{}
[
key:
string
]:
AnyValue
to
Recon
to
Recon
(
)
:
string
Returns
string
to
Recon
Block
to
Recon
Block
(
)
:
string
Returns
string
to
String
to
String
(
)
:
string
Returns
string
to
Value
to
Value
(
)
:
Value
Returns
Value
Abstract
unbind
Input
unbind
Input
(
key
:
string
)
:
void
Parameters
key:
string
Returns
void
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
(
)
:
Value
Returns
Value
Static
builder
builder
(
)
:
Builder
<
Item
,
Value
>
Returns
Builder
<
Item
,
Value
>
Static
create
create
(
initialCapacity
?:
number
)
:
Record
Parameters
Optional
initialCapacity:
number
Returns
Record
Static
empty
empty
(
)
:
Record
Returns
Record
Static
expand
expand
(
n
:
number
)
:
number
Parameters
n:
number
Returns
number
Static
extant
extant
(
)
:
Value
Returns
Value
Static
from
Any
from
Any
(
value
:
AnyRecord
)
:
Record
Parameters
value:
AnyRecord
Returns
Record
Static
from
Array
from
Array
(
array
:
{
length
?:
number
}
)
:
Record
Parameters
array:
{
length
?:
number
}
[
index:
number
]:
AnyItem
Optional
length
?:
number
Returns
Record
Static
from
Object
from
Object
(
object
:
{}
)
:
Record
Parameters
object:
{}
[
key:
string
]:
AnyValue
Returns
Record
Static
global
Scope
global
Scope
(
)
:
Item
Returns
Item
Static
of
of
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
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
Abstract
Record
Outlet
Abstract
Record
Streamlet
And
Outlet
Binary
Outlet
Bitwise
And
Outlet
Bitwise
Not
Outlet
Bitwise
OrOutlet
Bitwise
Xor
Outlet
Conditional
Outlet
Divide
Outlet
Eq
Outlet
Ge
Outlet
Get
Outlet
Gt
Outlet
Invoke
Outlet
Le
Outlet
Lt
Outlet
Minus
Outlet
Modulo
Outlet
Ne
Outlet
Negative
Outlet
Not
Outlet
Or
Outlet
Plus
Outlet
Positive
Outlet
Record
Field
Updater
Record
Model
Record
Scope
Record
Streamlet
constructor
field
Count
streamlet
Context
streamlet
Scope
Aliased
Flag
Immutable
Flag
key
length
precedence
tag
target
type
Order
value
Count
alias
and
appended
attr
bind
bind
Input
bitwise
And
bitwise
Not
bitwise
Or
bitwise
Xor
body
boolean
Value
branch
cast
clear
clone
coerce
commit
compare
To
compile
compile
Inlet
concat
conditional
debug
decohere
delete
deleted
disconnect
Inputs
disconnect
Outputs
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
index
Of
inlet
interpolate
To
inverse
invoke
is
Aliased
is
Array
is
Constant
is
Defined
is
Definite
is
Distinct
is
Empty
is
Mutable
is
Object
item
items
iterator
key
Equals
lambda
last
Index
Of
le
lt
max
min
minus
modulo
ne
negative
not
number
Value
or
outlet
plus
positive
prepended
push
recohere
set
set
Attr
set
Item
set
Slot
set
Streamlet
Context
set
Streamlet
Scope
slice
slot
splice
string
Value
sub
Record
substitute
tail
times
to
Any
to
Array
to
Object
to
Recon
to
Recon
Block
to
String
to
Value
unbind
Input
unflattened
updated
updated
Attr
updated
Slot
absent
builder
create
empty
expand
extant
from
Any
from
Array
from
Object
global
Scope
of
Reifier
Times
Outlet
Unary
Outlet
Record
Outlet
Dataflow
Record
Outlet
Generated using
TypeDoc