Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/client
ValueDownlink
Class ValueDownlink<V, VU>
Type parameters
V
VU =
never
Hierarchy
Downlink
OutletCombinators
<
V
>
ValueDownlink
Implements
Inlet
<
V
>
Outlet
<
V
>
Index
Constructors
constructor
Properties
context
flags
input
model
observers
outputs
own
Body
own
Host
Uri
own
Lane
Uri
own
Node
Uri
own
Prio
own
Rate
own
Value
Form
owner
state0
version
Accessors
session
type
Methods
bind
Input
bind
Output
body
close
close
Up
command
copy
decohere
decohere
Input
decohere
Output
did
Alias
Model
did
Close
did
Connect
did
Decohere
did
Disconnect
did
Fail
did
Link
did
Recohere
did
Set
did
Sync
did
Unlink
disconnect
Inputs
disconnect
Outputs
get
host
Did
Connect
host
Did
Disconnect
host
Did
Fail
host
Uri
initial
State
is
Authenticated
is
Connected
is
Linked
is
Synced
keep
Linked
keep
Synced
lane
Uri
map
memoize
node
Uri
observe
on
Command
on
Command
Message
on
Decohere
on
Event
on
Event
Message
on
Link
Request
on
Linked
Response
on
Recohere
on
Sync
Request
on
Synced
Response
on
Unlink
Request
on
Unlinked
Response
open
open
Up
output
Iterator
prio
rate
recohere
recohere
Input
recohere
Output
set
set
State
unbind
Input
unbind
Output
unbind
Outputs
unobserve
value
Did
Set
value
Form
value
Will
Set
watch
will
Decohere
will
Link
will
Recohere
will
Set
will
Sync
will
Unlink
init
Form
Constructors
constructor
new
Value
Downlink<V, VU>
(
context
:
DownlinkContext
, owner
:
null
|
DownlinkOwner
, init
?:
ValueDownlinkInit
<
V
,
VU
>
, hostUri
?:
Uri
, nodeUri
?:
Uri
, laneUri
?:
Uri
, prio
?:
number
, rate
?:
number
, body
?:
Value
, flags
?:
number
, observers
?:
ValueDownlinkObserver
<
V
,
VU
>
|
readonly
ValueDownlinkObserver
<
V
,
VU
>
[]
, valueForm
?:
Form
<
V
,
VU
>
, state0
?:
Value
)
:
ValueDownlink
<
V
,
VU
>
Type parameters
V
VU =
never
Parameters
context:
DownlinkContext
owner:
null
|
DownlinkOwner
Optional
init:
ValueDownlinkInit
<
V
,
VU
>
Optional
hostUri:
Uri
Optional
nodeUri:
Uri
Optional
laneUri:
Uri
Optional
prio:
number
Optional
rate:
number
Optional
body:
Value
Optional
flags:
number
Optional
observers:
ValueDownlinkObserver
<
V
,
VU
>
|
readonly
ValueDownlinkObserver
<
V
,
VU
>
[]
Optional
valueForm:
Form
<
V
,
VU
>
Optional
state0:
Value
Returns
ValueDownlink
<
V
,
VU
>
Properties
Readonly
context
context
:
DownlinkContext
Readonly
flags
flags
:
number
Readonly
input
input
:
null
|
Outlet
<
V
>
Readonly
model
model
:
null
|
ValueDownlinkModel
observers
observers
:
readonly
ValueDownlinkObserver
<
V
,
VU
>
[]
Readonly
outputs
outputs
:
readonly
Inlet
<
V
>
[]
Readonly
own
Body
own
Body
:
Value
Readonly
own
Host
Uri
own
Host
Uri
:
Uri
Readonly
own
Lane
Uri
own
Lane
Uri
:
Uri
Readonly
own
Node
Uri
own
Node
Uri
:
Uri
Readonly
own
Prio
own
Prio
:
number
Readonly
own
Rate
own
Rate
:
number
Readonly
own
Value
Form
own
Value
Form
:
Form
<
V
,
VU
>
Readonly
owner
owner
:
null
|
DownlinkOwner
Readonly
state0
state0
:
Value
Readonly
version
version
:
number
Accessors
session
get
session
(
)
:
Value
Returns
Value
type
get
type
(
)
:
DownlinkType
Returns
DownlinkType
Methods
bind
Input
bind
Input
(
newInput
:
null
|
Outlet
<
V
>
)
:
void
Parameters
newInput:
null
|
Outlet
<
V
>
Returns
void
bind
Output
bind
Output
(
output
:
Inlet
<
V
>
)
:
void
Parameters
output:
Inlet
<
V
>
Returns
void
body
body
(
)
:
Value
body
(
body
:
AnyValue
)
:
ValueDownlink
<
V
,
VU
>
Returns
Value
Parameters
body:
AnyValue
Returns
ValueDownlink
<
V
,
VU
>
close
close
(
)
:
void
Returns
void
close
Up
close
Up
(
)
:
void
Returns
void
command
command
(
body
:
AnyValue
)
:
void
Parameters
body:
AnyValue
Returns
void
Protected
copy
copy<V, VU>
(
context
:
DownlinkContext
, owner
:
null
|
DownlinkOwner
, hostUri
:
Uri
, nodeUri
:
Uri
, laneUri
:
Uri
, prio
:
number
, rate
:
number
, body
:
Value
, flags
:
number
, observers
:
readonly
ValueDownlinkObserver
<
V
,
VU
>
[]
, valueForm
?:
Form
<
V
,
VU
>
, state0
?:
Value
)
:
ValueDownlink
<
V
,
VU
>
Type parameters
V
VU
Parameters
context:
DownlinkContext
owner:
null
|
DownlinkOwner
hostUri:
Uri
nodeUri:
Uri
laneUri:
Uri
prio:
number
rate:
number
body:
Value
flags:
number
observers:
readonly
ValueDownlinkObserver
<
V
,
VU
>
[]
Optional
valueForm:
Form
<
V
,
VU
>
Optional
state0:
Value
Returns
ValueDownlink
<
V
,
VU
>
decohere
decohere
(
)
:
void
Returns
void
decohere
Input
decohere
Input
(
)
:
void
Returns
void
decohere
Output
decohere
Output
(
)
:
void
Returns
void
Protected
did
Alias
Model
did
Alias
Model
(
)
:
void
Returns
void
did
Close
did
Close
(
didClose
:
DownlinkDidClose
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didClose:
DownlinkDidClose
Returns
ValueDownlink
<
V
,
VU
>
did
Connect
did
Connect
(
didConnect
:
DownlinkDidConnect
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didConnect:
DownlinkDidConnect
Returns
ValueDownlink
<
V
,
VU
>
Protected
did
Decohere
did
Decohere
(
)
:
void
Returns
void
did
Disconnect
did
Disconnect
(
didDisconnect
:
DownlinkDidDisconnect
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didDisconnect:
DownlinkDidDisconnect
Returns
ValueDownlink
<
V
,
VU
>
did
Fail
did
Fail
(
didFail
:
DownlinkDidFail
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didFail:
DownlinkDidFail
Returns
ValueDownlink
<
V
,
VU
>
did
Link
did
Link
(
didLink
:
DownlinkDidLink
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didLink:
DownlinkDidLink
Returns
ValueDownlink
<
V
,
VU
>
Protected
did
Recohere
did
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
did
Set
did
Set
(
didSet
:
VaueDownlinkDidSet
<
V
,
VU
>
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didSet:
VaueDownlinkDidSet
<
V
,
VU
>
Returns
ValueDownlink
<
V
,
VU
>
did
Sync
did
Sync
(
didSync
:
DownlinkDidSync
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didSync:
DownlinkDidSync
Returns
ValueDownlink
<
V
,
VU
>
did
Unlink
did
Unlink
(
didUnlink
:
DownlinkDidUnlink
)
:
ValueDownlink
<
V
,
VU
>
Parameters
didUnlink:
DownlinkDidUnlink
Returns
ValueDownlink
<
V
,
VU
>
disconnect
Inputs
disconnect
Inputs
(
)
:
void
Returns
void
disconnect
Outputs
disconnect
Outputs
(
)
:
void
Returns
void
get
get
(
)
:
V
Returns
V
host
Did
Connect
host
Did
Connect
(
)
:
void
Returns
void
host
Did
Disconnect
host
Did
Disconnect
(
)
:
void
Returns
void
host
Did
Fail
host
Did
Fail
(
error
:
unknown
)
:
void
Parameters
error:
unknown
Returns
void
host
Uri
host
Uri
(
)
:
Uri
host
Uri
(
hostUri
:
AnyUri
)
:
ValueDownlink
<
V
,
VU
>
Returns
Uri
Parameters
hostUri:
AnyUri
Returns
ValueDownlink
<
V
,
VU
>
initial
State
initial
State
(
)
:
Value
initial
State
(
state0
:
Value
)
:
ValueDownlink
<
V
,
VU
>
Returns
Value
Parameters
state0:
Value
Returns
ValueDownlink
<
V
,
VU
>
is
Authenticated
is
Authenticated
(
)
:
boolean
Returns
boolean
is
Connected
is
Connected
(
)
:
boolean
Returns
boolean
is
Linked
is
Linked
(
)
:
boolean
Returns
boolean
is
Synced
is
Synced
(
)
:
boolean
Returns
boolean
keep
Linked
keep
Linked
(
)
:
boolean
keep
Linked
(
keepLinked
:
boolean
)
:
ValueDownlink
<
V
,
VU
>
Returns
boolean
Parameters
keepLinked:
boolean
Returns
ValueDownlink
<
V
,
VU
>
keep
Synced
keep
Synced
(
)
:
boolean
keep
Synced
(
keepSynced
:
boolean
)
:
ValueDownlink
<
V
,
VU
>
Returns
boolean
Parameters
keepSynced:
boolean
Returns
ValueDownlink
<
V
,
VU
>
lane
Uri
lane
Uri
(
)
:
Uri
lane
Uri
(
laneUri
:
AnyUri
)
:
ValueDownlink
<
V
,
VU
>
Returns
Uri
Parameters
laneUri:
AnyUri
Returns
ValueDownlink
<
V
,
VU
>
map
map<O2>
(
func
:
MapValueFunction
<
V
,
O2
>
)
:
Outlet
<
O2
>
Type parameters
O2
Parameters
func:
MapValueFunction
<
V
,
O2
>
Returns
Outlet
<
O2
>
memoize
memoize
(
)
:
Outlet
<
V
>
Returns
Outlet
<
V
>
node
Uri
node
Uri
(
)
:
Uri
node
Uri
(
nodeUri
:
AnyUri
)
:
ValueDownlink
<
V
,
VU
>
Returns
Uri
Parameters
nodeUri:
AnyUri
Returns
ValueDownlink
<
V
,
VU
>
observe
observe
(
observer
:
ValueDownlinkObserver
<
V
,
VU
>
)
:
ValueDownlink
<
V
,
VU
>
Parameters
observer:
ValueDownlinkObserver
<
V
,
VU
>
Returns
ValueDownlink
<
V
,
VU
>
on
Command
on
Command
(
onCommand
:
DownlinkOnCommand
)
:
ValueDownlink
<
V
,
VU
>
Parameters
onCommand:
DownlinkOnCommand
Returns
ValueDownlink
<
V
,
VU
>
on
Command
Message
on
Command
Message
(
body
:
Value
)
:
void
Parameters
body:
Value
Returns
void
Protected
on
Decohere
on
Decohere
(
)
:
void
Returns
void
on
Event
on
Event
(
onEvent
:
DownlinkOnEvent
)
:
ValueDownlink
<
V
,
VU
>
Parameters
onEvent:
DownlinkOnEvent
Returns
ValueDownlink
<
V
,
VU
>
on
Event
Message
on
Event
Message
(
message
:
EventMessage
)
:
void
Parameters
message:
EventMessage
Returns
void
on
Link
Request
on
Link
Request
(
request
?:
LinkRequest
)
:
void
Parameters
Optional
request:
LinkRequest
Returns
void
on
Linked
Response
on
Linked
Response
(
response
?:
LinkedResponse
)
:
void
Parameters
Optional
response:
LinkedResponse
Returns
void
Protected
on
Recohere
on
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
on
Sync
Request
on
Sync
Request
(
request
?:
SyncRequest
)
:
void
Parameters
Optional
request:
SyncRequest
Returns
void
on
Synced
Response
on
Synced
Response
(
response
?:
SyncedResponse
)
:
void
Parameters
Optional
response:
SyncedResponse
Returns
void
on
Unlink
Request
on
Unlink
Request
(
request
?:
UnlinkRequest
)
:
void
Parameters
Optional
request:
UnlinkRequest
Returns
void
on
Unlinked
Response
on
Unlinked
Response
(
response
?:
UnlinkedResponse
)
:
void
Parameters
Optional
response:
UnlinkedResponse
Returns
void
open
open
(
)
:
ValueDownlink
<
V
,
VU
>
Returns
ValueDownlink
<
V
,
VU
>
open
Up
open
Up
(
host
:
Host
)
:
void
Parameters
host:
Host
Returns
void
output
Iterator
output
Iterator
(
)
:
Cursor
<
Inlet
<
V
>
>
Returns
Cursor
<
Inlet
<
V
>
>
prio
prio
(
)
:
number
prio
(
prio
:
number
)
:
ValueDownlink
<
V
,
VU
>
Returns
number
Parameters
prio:
number
Returns
ValueDownlink
<
V
,
VU
>
rate
rate
(
)
:
number
rate
(
rate
:
number
)
:
ValueDownlink
<
V
,
VU
>
Returns
number
Parameters
rate:
number
Returns
ValueDownlink
<
V
,
VU
>
recohere
recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
recohere
Input
recohere
Input
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
recohere
Output
recohere
Output
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
set
set
(
newObject
:
V
|
VU
)
:
void
Parameters
newObject:
V
|
VU
Returns
void
set
State
set
State
(
state
:
Value
)
:
void
Parameters
state:
Value
Returns
void
unbind
Input
unbind
Input
(
)
:
void
Returns
void
unbind
Output
unbind
Output
(
output
:
Inlet
<
V
>
)
:
void
Parameters
output:
Inlet
<
V
>
Returns
void
unbind
Outputs
unbind
Outputs
(
)
:
void
Returns
void
unobserve
unobserve
(
observer
:
unknown
)
:
ValueDownlink
<
V
,
VU
>
Parameters
observer:
unknown
Returns
ValueDownlink
<
V
,
VU
>
value
Did
Set
value
Did
Set
(
newValue
:
Value
, oldValue
:
Value
)
:
void
Parameters
newValue:
Value
oldValue:
Value
Returns
void
value
Form
value
Form
(
)
:
Form
<
V
,
VU
>
value
Form<V2, V2U>
(
valueForm
:
Form
<
V2
,
V2U
>
)
:
ValueDownlink
<
V2
,
V2U
>
Returns
Form
<
V
,
VU
>
Type parameters
V2
V2U =
never
Parameters
valueForm:
Form
<
V2
,
V2U
>
Returns
ValueDownlink
<
V2
,
V2U
>
value
Will
Set
value
Will
Set
(
newValue
:
Value
)
:
Value
Parameters
newValue:
Value
Returns
Value
watch
watch
(
func
:
WatchValueFunction
<
V
>
)
:
ValueDownlink
<
V
,
VU
>
Parameters
func:
WatchValueFunction
<
V
>
Returns
ValueDownlink
<
V
,
VU
>
Protected
will
Decohere
will
Decohere
(
)
:
void
Returns
void
will
Link
will
Link
(
willLink
:
DownlinkWillLink
)
:
ValueDownlink
<
V
,
VU
>
Parameters
willLink:
DownlinkWillLink
Returns
ValueDownlink
<
V
,
VU
>
Protected
will
Recohere
will
Recohere
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
will
Set
will
Set
(
willSet
:
ValueDownlinkWillSet
<
V
,
VU
>
)
:
ValueDownlink
<
V
,
VU
>
Parameters
willSet:
ValueDownlinkWillSet
<
V
,
VU
>
Returns
ValueDownlink
<
V
,
VU
>
will
Sync
will
Sync
(
willSync
:
DownlinkWillSync
)
:
ValueDownlink
<
V
,
VU
>
Parameters
willSync:
DownlinkWillSync
Returns
ValueDownlink
<
V
,
VU
>
will
Unlink
will
Unlink
(
willUnlink
:
DownlinkWillUnlink
)
:
ValueDownlink
<
V
,
VU
>
Parameters
willUnlink:
DownlinkWillUnlink
Returns
ValueDownlink
<
V
,
VU
>
Static
init
Form
init
Form
(
)
:
Form
<
undefined
|
DownlinkInit
,
never
>
Returns
Form
<
undefined
|
DownlinkInit
,
never
>
Modules
@swim/system
@swim/core
@swim/mesh
@swim/warp
@swim/client
@swim/toolkit
Value
Downlink
constructor
context
flags
input
model
observers
outputs
own
Body
own
Host
Uri
own
Lane
Uri
own
Node
Uri
own
Prio
own
Rate
own
Value
Form
owner
state0
version
session
type
bind
Input
bind
Output
body
close
close
Up
command
copy
decohere
decohere
Input
decohere
Output
did
Alias
Model
did
Close
did
Connect
did
Decohere
did
Disconnect
did
Fail
did
Link
did
Recohere
did
Set
did
Sync
did
Unlink
disconnect
Inputs
disconnect
Outputs
get
host
Did
Connect
host
Did
Disconnect
host
Did
Fail
host
Uri
initial
State
is
Authenticated
is
Connected
is
Linked
is
Synced
keep
Linked
keep
Synced
lane
Uri
map
memoize
node
Uri
observe
on
Command
on
Command
Message
on
Decohere
on
Event
on
Event
Message
on
Link
Request
on
Linked
Response
on
Recohere
on
Sync
Request
on
Synced
Response
on
Unlink
Request
on
Unlinked
Response
open
open
Up
output
Iterator
prio
rate
recohere
recohere
Input
recohere
Output
set
set
State
unbind
Input
unbind
Output
unbind
Outputs
unobserve
value
Did
Set
value
Form
value
Will
Set
watch
will
Decohere
will
Link
will
Recohere
will
Set
will
Sync
will
Unlink
init
Form
Generated using
TypeDoc