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
BridgeFunc
Class BridgeFunc
Hierarchy
Func
BridgeFunc
Index
Constructors
constructor
Accessors
key
length
precedence
tag
target
type
Order
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
expand
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
builder
empty
extant
from
Any
global
Scope
Constructors
constructor
new
Bridge
Func
(
)
:
BridgeFunc
Returns
BridgeFunc
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
alias
alias
(
)
:
void
Returns
void
and
and
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
appended
appended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
bitwise
And
bitwise
And
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
bitwise
Not
bitwise
Not
(
)
:
Operator
Returns
Operator
bitwise
Or
bitwise
Or
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
bitwise
Xor
bitwise
Xor
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
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
(
)
:
Value
Returns
Value
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
clone
clone
(
)
:
Value
Returns
Value
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
(
)
:
BridgeFunc
Returns
BridgeFunc
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
:
Value
, elseTerm
:
Value
)
:
Value
conditional
(
thenTerm
:
AnyItem
, elseTerm
:
AnyItem
)
:
Item
Parameters
thenTerm:
Value
elseTerm:
Value
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
eq
eq
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
equals
equals
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
equivalent
To
equivalent
To
(
that
:
unknown
)
:
boolean
Parameters
that:
unknown
Returns
boolean
evaluate
evaluate
(
interpreter
:
AnyInterpreter
)
:
Item
Parameters
interpreter:
AnyInterpreter
Returns
Item
expand
expand
(
args
:
Value
, interpreter
:
Interpreter
, operator
:
InvokeOperator
)
:
undefined
|
Item
Parameters
args:
Value
interpreter:
Interpreter
operator:
InvokeOperator
Returns
undefined
|
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
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
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
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
:
Value
)
:
Interpolator
<
Value
>
interpolate
To
(
that
:
Item
)
:
Interpolator
<
Item
>
interpolate
To
(
that
:
unknown
)
:
null
|
Interpolator
<
Item
>
Parameters
that:
Value
Returns
Interpolator
<
Value
>
Parameters
that:
Item
Returns
Interpolator
<
Item
>
Parameters
that:
unknown
Returns
null
|
Interpolator
<
Item
>
inverse
inverse
(
)
:
Operator
Returns
Operator
Abstract
invoke
invoke
(
args
:
Value
, interpreter
?:
Interpreter
, operator
?:
InvokeOperator
)
:
Item
Parameters
args:
Value
Optional
interpreter:
Interpreter
Optional
operator:
InvokeOperator
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
lt
lt
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
max
max
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
min
min
(
that
:
Item
)
:
Item
Parameters
that:
Item
Returns
Item
minus
minus
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
modulo
modulo
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
ne
ne
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
negative
negative
(
)
:
Operator
Returns
Operator
not
not
(
)
:
Operator
Returns
Operator
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
plus
plus
(
that
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
positive
positive
(
)
:
Operator
Returns
Operator
prepended
prepended
(
...
items
:
AnyItem
[]
)
:
Record
Parameters
Rest
...
items:
AnyItem
[]
Returns
Record
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
:
AnyItem
)
:
Operator
Parameters
that:
AnyItem
Returns
Operator
to
Any
to
Any
(
)
:
AnyValue
Returns
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
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
empty
empty
(
)
:
Value
Returns
Value
Static
extant
extant
(
)
:
Value
Returns
Value
Static
from
Any
from
Any
(
value
:
AnyValue
)
:
Value
Parameters
value:
AnyValue
Returns
Value
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
Bridge
Func
constructor
key
length
precedence
tag
target
type
Order
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
expand
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
builder
empty
extant
from
Any
global
Scope
Generated using
TypeDoc