Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/streamlet
AbstractStreamlet
Class AbstractStreamlet<I, O>
Type parameters
I =
unknown
O =
I
Hierarchy
AbstractStreamlet
Implements
GenericStreamlet
<
I
,
O
>
Index
Constructors
constructor
Properties
streamlet
Context
streamlet
Scope
version
Methods
bind
Input
decohere
did
Decohere
did
Decohere
Inlet
did
Decohere
Outlet
did
Recohere
did
Recohere
Inlet
did
Recohere
Outlet
disconnect
Inputs
disconnect
Outputs
get
Input
get
Output
inlet
inoutlet
on
Decohere
on
Decohere
Outlets
on
Recohere
on
Recohere
Inlets
on
Recohere
Outlets
outlet
recohere
set
Streamlet
Context
set
Streamlet
Scope
unbind
Input
will
Decohere
will
Decohere
Inlet
will
Decohere
Outlet
will
Recohere
will
Recohere
Inlet
will
Recohere
Outlet
decohere
Outlets
decorate
Inlet
decorate
Inoutlet
decorate
Outlet
disconnect
Inputs
disconnect
Outputs
init
recohere
Inlets
recohere
Outlets
reflect
Each
Inlet
reflect
Each
Outlet
reflect
Inlet
Count
reflect
Inlet
Field
reflect
Inlet
Index
reflect
Inlet
Key
reflect
Inoutlet
Field
reflect
Map
Inlet
Field
reflect
Map
Inoutlet
Field
reflect
Map
Outlet
Field
reflect
Outlet
Count
reflect
Outlet
Field
reflect
Outlet
Index
reflect
Outlet
Key
reflect
Value
Inlet
Field
reflect
Value
Inoutlet
Field
reflect
Value
Outlet
Field
Constructors
constructor
new
Abstract
Streamlet<I, O>
(
scope
?:
null
|
StreamletScope
<
O
>
)
:
AbstractStreamlet
<
I
,
O
>
Type parameters
I =
unknown
O =
I
Parameters
scope:
null
|
StreamletScope
<
O
>
= null
Returns
AbstractStreamlet
<
I
,
O
>
Properties
Readonly
streamlet
Context
streamlet
Context
:
null
|
StreamletContext
Readonly
streamlet
Scope
streamlet
Scope
:
null
|
StreamletScope
<
O
>
Readonly
version
version
:
number
internal
Methods
bind
Input
bind
Input
(
key
:
string
, input
:
Outlet
<
I
>
)
:
void
Parameters
key:
string
input:
Outlet
<
I
>
Returns
void
decohere
decohere
(
)
:
void
Returns
void
Protected
did
Decohere
did
Decohere
(
)
:
void
Returns
void
did
Decohere
Inlet
did
Decohere
Inlet
(
inlet
:
Inlet
<
I
>
)
:
void
Parameters
inlet:
Inlet
<
I
>
Returns
void
did
Decohere
Outlet
did
Decohere
Outlet
(
outlet
:
Outlet
<
O
>
)
:
void
Parameters
outlet:
Outlet
<
O
>
Returns
void
Protected
did
Recohere
did
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
did
Recohere
Inlet
did
Recohere
Inlet
(
inlet
:
Inlet
<
I
>
, version
:
number
)
:
void
Parameters
inlet:
Inlet
<
I
>
version:
number
Returns
void
did
Recohere
Outlet
did
Recohere
Outlet
(
outlet
:
Outlet
<
O
>
, version
:
number
)
:
void
Parameters
outlet:
Outlet
<
O
>
version:
number
Returns
void
disconnect
Inputs
disconnect
Inputs
(
)
:
void
Returns
void
disconnect
Outputs
disconnect
Outputs
(
)
:
void
Returns
void
get
Input
get
Input<I2>
(
inlet
:
string
|
Inlet
<
I2
>
)
:
undefined
|
I2
get
Input<I2, E>
(
inlet
:
string
|
Inlet
<
I2
>
, orElse
:
E
)
:
I2
|
E
Type parameters
I2
Parameters
inlet:
string
|
Inlet
<
I2
>
Returns
undefined
|
I2
Type parameters
I2
E =
I2
Parameters
inlet:
string
|
Inlet
<
I2
>
orElse:
E
Returns
I2
|
E
get
Output
get
Output
(
outlet
:
string
|
Outlet
<
O
>
)
:
undefined
|
O
Parameters
outlet:
string
|
Outlet
<
O
>
Returns
undefined
|
O
inlet
inlet
(
key
:
string
)
:
null
|
Inlet
<
I
>
inlet<I2>
(
)
:
Inlet
<
I2
>
Parameters
key:
string
Returns
null
|
Inlet
<
I
>
Type parameters
I2
Returns
Inlet
<
I2
>
inoutlet
inoutlet<I2, O2>
(
)
:
Inoutlet
<
I2
,
O2
>
Type parameters
I2
O2
Returns
Inoutlet
<
I2
,
O2
>
Protected
on
Decohere
on
Decohere
(
)
:
void
Returns
void
Protected
on
Decohere
Outlets
on
Decohere
Outlets
(
)
:
void
Returns
void
Protected
on
Recohere
on
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
Protected
on
Recohere
Inlets
on
Recohere
Inlets
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
Protected
on
Recohere
Outlets
on
Recohere
Outlets
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
outlet
outlet
(
key
:
string
|
Outlet
<
O
>
)
:
null
|
Outlet
<
O
>
outlet<O2>
(
)
:
Outlet
<
O2
>
Parameters
key:
string
|
Outlet
<
O
>
Returns
null
|
Outlet
<
O
>
Type parameters
O2
Returns
Outlet
<
O2
>
recohere
recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
set
Streamlet
Context
set
Streamlet
Context
(
context
:
null
|
StreamletContext
)
:
void
Parameters
context:
null
|
StreamletContext
Returns
void
set
Streamlet
Scope
set
Streamlet
Scope
(
scope
:
null
|
StreamletScope
<
O
>
)
:
void
Parameters
scope:
null
|
StreamletScope
<
O
>
Returns
void
unbind
Input
unbind
Input
(
key
:
string
)
:
void
Parameters
key:
string
Returns
void
Protected
will
Decohere
will
Decohere
(
)
:
void
Returns
void
will
Decohere
Inlet
will
Decohere
Inlet
(
inlet
:
Inlet
<
I
>
)
:
void
Parameters
inlet:
Inlet
<
I
>
Returns
void
will
Decohere
Outlet
will
Decohere
Outlet
(
outlet
:
Outlet
<
O
>
)
:
void
Parameters
outlet:
Outlet
<
O
>
Returns
void
Protected
will
Recohere
will
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
will
Recohere
Inlet
will
Recohere
Inlet
(
inlet
:
Inlet
<
I
>
, version
:
number
)
:
void
Parameters
inlet:
Inlet
<
I
>
version:
number
Returns
void
will
Recohere
Outlet
will
Recohere
Outlet
(
outlet
:
Outlet
<
O
>
, version
:
number
)
:
void
Parameters
outlet:
Outlet
<
O
>
version:
number
Returns
void
Static
decohere
Outlets
decohere
Outlets<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
void
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
void
Static
decorate
Inlet
decorate
Inlet
(
options
:
InletOptions
, target
:
StreamletPrototype
, propertyKey
:
string
|
symbol
)
:
void
internal
Parameters
options:
InletOptions
target:
StreamletPrototype
propertyKey:
string
|
symbol
Returns
void
Static
decorate
Inoutlet
decorate
Inoutlet
(
options
:
InoutletOptions
, target
:
StreamletPrototype
, propertyKey
:
string
|
symbol
)
:
void
internal
Parameters
options:
InoutletOptions
target:
StreamletPrototype
propertyKey:
string
|
symbol
Returns
void
Static
decorate
Outlet
decorate
Outlet
(
options
:
OutletOptions
, target
:
StreamletPrototype
, propertyKey
:
string
|
symbol
)
:
void
internal
Parameters
options:
OutletOptions
target:
StreamletPrototype
propertyKey:
string
|
symbol
Returns
void
Static
disconnect
Inputs
disconnect
Inputs<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
void
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
void
Static
disconnect
Outputs
disconnect
Outputs<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
void
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
void
Static
init
init
(
streamletPrototype
:
StreamletPrototype
)
:
void
internal
Parameters
streamletPrototype:
StreamletPrototype
Returns
void
Static
recohere
Inlets
recohere
Inlets<I, O>
(
version
:
number
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
void
internal
Type parameters
I
O
Parameters
version:
number
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
void
Static
recohere
Outlets
recohere
Outlets<I, O>
(
version
:
number
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
void
internal
Type parameters
I
O
Parameters
version:
number
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
void
Static
reflect
Each
Inlet
reflect
Each
Inlet<I, O, T>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
, callback
:
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
=>
void
|
T
)
:
undefined
|
T
reflect
Each
Inlet<I, O, T, S>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
, callback
:
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
internal
Type parameters
I
O
T
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
callback:
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
=>
void
|
T
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
:
void
|
T
Parameters
inlet:
Inlet
<
I
>
name:
string
index:
number
Returns
void
|
T
Returns
undefined
|
T
internal
Type parameters
I
O
T
S
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
callback:
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
=>
void
|
T
(
inlet
:
Inlet
<
I
>
, name
:
string
, index
:
number
)
:
void
|
T
Parameters
inlet:
Inlet
<
I
>
name:
string
index:
number
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
Static
reflect
Each
Outlet
reflect
Each
Outlet<I, O, T>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
, callback
:
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
=>
void
|
T
)
:
undefined
|
T
reflect
Each
Outlet<I, O, T, S>
(
streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
, callback
:
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
internal
Type parameters
I
O
T
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
callback:
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
=>
void
|
T
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
:
void
|
T
Parameters
outlet:
Outlet
<
O
>
name:
string
index:
number
Returns
void
|
T
Returns
undefined
|
T
internal
Type parameters
I
O
T
S
Parameters
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
callback:
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
=>
void
|
T
(
outlet
:
Outlet
<
O
>
, name
:
string
, index
:
number
)
:
void
|
T
Parameters
outlet:
Outlet
<
O
>
name:
string
index:
number
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
Static
reflect
Inlet
Count
reflect
Inlet
Count
(
streamletPrototype
:
null
|
StreamletPrototype
)
:
number
internal
Parameters
streamletPrototype:
null
|
StreamletPrototype
Returns
number
Static
reflect
Inlet
Field
reflect
Inlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, inletDescriptor
:
InletDescriptor
)
:
Inlet
<
I
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
inletDescriptor:
InletDescriptor
Returns
Inlet
<
I
>
Static
reflect
Inlet
Index
reflect
Inlet
Index<I, O>
(
index
:
number
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
null
|
[
string
,
Inlet
<
I
>
]
internal
Type parameters
I
O
Parameters
index:
number
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
null
|
[
string
,
Inlet
<
I
>
]
Static
reflect
Inlet
Key
reflect
Inlet
Key<I, O>
(
key
:
string
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
null
|
Inlet
<
I
>
internal
Type parameters
I
O
Parameters
key:
string
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
null
|
Inlet
<
I
>
Static
reflect
Inoutlet
Field
reflect
Inoutlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, inoutletDescriptor
:
InoutletDescriptor
)
:
Inoutlet
<
I
,
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
inoutletDescriptor:
InoutletDescriptor
Returns
Inoutlet
<
I
,
O
>
Static
reflect
Map
Inlet
Field
reflect
Map
Inlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Inlet
<
I
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Inlet
<
I
>
Static
reflect
Map
Inoutlet
Field
reflect
Map
Inoutlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Inoutlet
<
I
,
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Inoutlet
<
I
,
O
>
Static
reflect
Map
Outlet
Field
reflect
Map
Outlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Outlet
<
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Outlet
<
O
>
Static
reflect
Outlet
Count
reflect
Outlet
Count
(
streamletPrototype
:
null
|
StreamletPrototype
)
:
number
internal
Parameters
streamletPrototype:
null
|
StreamletPrototype
Returns
number
Static
reflect
Outlet
Field
reflect
Outlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, outletDescriptor
:
OutletDescriptor
)
:
Outlet
<
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
outletDescriptor:
OutletDescriptor
Returns
Outlet
<
O
>
Static
reflect
Outlet
Index
reflect
Outlet
Index<I, O>
(
index
:
number
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
null
|
[
string
,
Outlet
<
O
>
]
internal
Type parameters
I
O
Parameters
index:
number
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
null
|
[
string
,
Outlet
<
O
>
]
Static
reflect
Outlet
Key
reflect
Outlet
Key<I, O>
(
key
:
string
, streamlet
:
Streamlet
<
I
,
O
>
, streamletPrototype
:
null
|
StreamletPrototype
)
:
null
|
Outlet
<
O
>
internal
Type parameters
I
O
Parameters
key:
string
streamlet:
Streamlet
<
I
,
O
>
streamletPrototype:
null
|
StreamletPrototype
Returns
null
|
Outlet
<
O
>
Static
reflect
Value
Inlet
Field
reflect
Value
Inlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Inlet
<
I
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Inlet
<
I
>
Static
reflect
Value
Inoutlet
Field
reflect
Value
Inoutlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Inoutlet
<
I
,
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Inoutlet
<
I
,
O
>
Static
reflect
Value
Outlet
Field
reflect
Value
Outlet
Field<I, O>
(
streamlet
:
Streamlet
<
I
,
O
>
, key
:
string
)
:
Outlet
<
O
>
internal
Type parameters
I
O
Parameters
streamlet:
Streamlet
<
I
,
O
>
key:
string
Returns
Outlet
<
O
>
Modules
@swim/runtime
@swim/core
@swim/util
@swim/codec
@swim/fastener
@swim/collections
@swim/constraint
@swim/structure
@swim/streamlet
@swim/dataflow
@swim/recon
@swim/uri
@swim/math
@swim/geo
@swim/time
@swim/host
@swim/toolkit
Abstract
Streamlet
constructor
streamlet
Context
streamlet
Scope
version
bind
Input
decohere
did
Decohere
did
Decohere
Inlet
did
Decohere
Outlet
did
Recohere
did
Recohere
Inlet
did
Recohere
Outlet
disconnect
Inputs
disconnect
Outputs
get
Input
get
Output
inlet
inoutlet
on
Decohere
on
Decohere
Outlets
on
Recohere
on
Recohere
Inlets
on
Recohere
Outlets
outlet
recohere
set
Streamlet
Context
set
Streamlet
Scope
unbind
Input
will
Decohere
will
Decohere
Inlet
will
Decohere
Outlet
will
Recohere
will
Recohere
Inlet
will
Recohere
Outlet
decohere
Outlets
decorate
Inlet
decorate
Inoutlet
decorate
Outlet
disconnect
Inputs
disconnect
Outputs
init
recohere
Inlets
recohere
Outlets
reflect
Each
Inlet
reflect
Each
Outlet
reflect
Inlet
Count
reflect
Inlet
Field
reflect
Inlet
Index
reflect
Inlet
Key
reflect
Inoutlet
Field
reflect
Map
Inlet
Field
reflect
Map
Inoutlet
Field
reflect
Map
Outlet
Field
reflect
Outlet
Count
reflect
Outlet
Field
reflect
Outlet
Index
reflect
Outlet
Key
reflect
Value
Inlet
Field
reflect
Value
Inoutlet
Field
reflect
Value
Outlet
Field
Generated using
TypeDoc