Search
Preparing search index...
The search index is not available
swimOS
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
@swim/client
MapDownlink
Class MapDownlink<K, V, KU, VU>
Type parameters
K
:
KU
V
:
VU
KU
VU
Hierarchy
Downlink
MapDownlink
Implements
OrderedMap
<
K
,
V
>
MapInlet
<
K
,
V
,
Map
<
K
,
V
>
>
MapOutlet
<
K
,
V
,
MapDownlink
<
K
,
V
,
KU
,
VU
>
>
Index
Accessors
size
Methods
bind
Input
bind
Output
body
clear
close
command
copy
delete
did
Clear
did
Close
did
Connect
did
Disconnect
did
Drop
did
Fail
did
Invalidate
did
Invalidate
Key
did
Link
did
Reconcile
did
Reconcile
Key
did
Remove
did
Sync
did
Take
did
Unlink
did
Update
disconnect
Inputs
disconnect
Outputs
drop
entries
filter
first
Entry
first
Key
first
Value
for
Each
get
get
Entry
has
host
Uri
initial
State
input
invalidate
invalidate
Input
invalidate
Input
Key
invalidate
Key
invalidate
Output
invalidate
Output
Key
is
Authenticated
is
Connected
is
Empty
is
Linked
is
Synced
keep
Linked
keep
Synced
key
Form
key
Iterator
keys
lane
Uri
last
Entry
last
Key
last
Value
map
memoize
next
Entry
next
Key
next
Value
node
Uri
observe
on
Command
on
Event
on
Invalidate
on
Invalidate
Key
on
Reconcile
on
Reconcile
Key
open
outlet
output
Iterator
previous
Entry
previous
Key
previous
Value
prio
rate
reconcile
reconcile
Input
reconcile
Input
Key
reconcile
Key
reconcile
Output
reconcile
Output
Key
reduce
session
set
set
State
snapshot
take
type
unbind
Input
unbind
Output
unbind
Outputs
unobserve
value
Form
values
watch
will
Clear
will
Drop
will
Invalidate
will
Invalidate
Key
will
Link
will
Reconcile
will
Reconcile
Key
will
Remove
will
Sync
will
Take
will
Unlink
will
Update
init
Form
Accessors
size
get
size
(
)
:
number
Returns
number
Methods
bind
Input
bind
Input
(
input
:
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
)
:
void
Parameters
input:
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
Returns
void
bind
Output
bind
Output
(
output
:
Inlet
<
MapDownlink
<
K
,
V
>
>
)
:
void
Parameters
output:
Inlet
<
MapDownlink
<
K
,
V
>
>
Returns
void
body
body
(
)
:
Value
body
(
body
:
AnyValue
)
:
this
Returns
Value
Parameters
body:
AnyValue
Returns
this
clear
clear
(
)
:
void
Returns
void
close
close
(
)
:
void
Returns
void
command
command
(
body
:
AnyValue
)
:
void
Parameters
body:
AnyValue
Returns
void
Protected
copy
copy
(
context
:
DownlinkContext
, owner
:
DownlinkOwner
|
undefined
, hostUri
:
Uri
, nodeUri
:
Uri
, laneUri
:
Uri
, prio
:
number
, rate
:
number
, body
:
Value
, flags
:
number
, observers
:
ReadonlyArray
<
MapDownlinkObserver
<
K
,
V
,
KU
,
VU
>
>
|
null
, keyForm
?:
Form
<
K
,
KU
>
, valueForm
?:
Form
<
V
,
VU
>
, state0
?:
BTree
<
Value
,
Value
>
)
:
this
Parameters
context:
DownlinkContext
owner:
DownlinkOwner
|
undefined
hostUri:
Uri
nodeUri:
Uri
laneUri:
Uri
prio:
number
rate:
number
body:
Value
flags:
number
observers:
ReadonlyArray
<
MapDownlinkObserver
<
K
,
V
,
KU
,
VU
>
>
|
null
Optional
keyForm:
Form
<
K
,
KU
>
Optional
valueForm:
Form
<
V
,
VU
>
Optional
state0:
BTree
<
Value
,
Value
>
Returns
this
delete
delete
(
key
:
KU
)
:
boolean
Parameters
key:
KU
Returns
boolean
did
Clear
did
Clear
(
didClear
:
MapDownlinkDidClear
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
didClear:
MapDownlinkDidClear
<
K
,
V
,
KU
,
VU
>
Returns
this
did
Close
did
Close
(
didClose
:
DownlinkDidClose
)
:
this
Parameters
didClose:
DownlinkDidClose
Returns
this
did
Connect
did
Connect
(
didConnect
:
DownlinkDidConnect
)
:
this
Parameters
didConnect:
DownlinkDidConnect
Returns
this
did
Disconnect
did
Disconnect
(
didDisconnect
:
DownlinkDidDisconnect
)
:
this
Parameters
didDisconnect:
DownlinkDidDisconnect
Returns
this
did
Drop
did
Drop
(
didDrop
:
MapDownlinkDidDrop
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
didDrop:
MapDownlinkDidDrop
<
K
,
V
,
KU
,
VU
>
Returns
this
did
Fail
did
Fail
(
didFail
:
DownlinkDidFail
)
:
this
Parameters
didFail:
DownlinkDidFail
Returns
this
Protected
did
Invalidate
did
Invalidate
(
)
:
void
Returns
void
Protected
did
Invalidate
Key
did
Invalidate
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
did
Link
did
Link
(
didLink
:
DownlinkDidLink
)
:
this
Parameters
didLink:
DownlinkDidLink
Returns
this
Protected
did
Reconcile
did
Reconcile
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
Protected
did
Reconcile
Key
did
Reconcile
Key
(
key
:
K
, effect
:
KeyEffect
, version
:
number
)
:
void
Parameters
key:
K
effect:
KeyEffect
version:
number
Returns
void
did
Remove
did
Remove
(
didRemove
:
MapDownlinkDidRemove
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
didRemove:
MapDownlinkDidRemove
<
K
,
V
,
KU
,
VU
>
Returns
this
did
Sync
did
Sync
(
didSync
:
DownlinkDidSync
)
:
this
Parameters
didSync:
DownlinkDidSync
Returns
this
did
Take
did
Take
(
didTake
:
MapDownlinkDidTake
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
didTake:
MapDownlinkDidTake
<
K
,
V
,
KU
,
VU
>
Returns
this
did
Unlink
did
Unlink
(
didUnlink
:
DownlinkDidUnlink
)
:
this
Parameters
didUnlink:
DownlinkDidUnlink
Returns
this
did
Update
did
Update
(
didUpdate
:
MapDownlinkDidUpdate
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
didUpdate:
MapDownlinkDidUpdate
<
K
,
V
,
KU
,
VU
>
Returns
this
disconnect
Inputs
disconnect
Inputs
(
)
:
void
Returns
void
disconnect
Outputs
disconnect
Outputs
(
)
:
void
Returns
void
drop
drop
(
lower
:
number
)
:
this
Parameters
lower:
number
Returns
this
entries
entries
(
)
:
Cursor
<
[
K
,
V
]
>
Returns
Cursor
<
[
K
,
V
]
>
filter
filter
(
func
:
FilterFieldsFunction
<
K
,
V
>
)
:
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
Parameters
func:
FilterFieldsFunction
<
K
,
V
>
Returns
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
first
Entry
first
Entry
(
)
:
[
K
,
V
]
|
undefined
Returns
[
K
,
V
]
|
undefined
first
Key
first
Key
(
)
:
K
|
undefined
Returns
K
|
undefined
first
Value
first
Value
(
)
:
V
|
undefined
Returns
V
|
undefined
for
Each
for
Each<T, S>
(
callback
:
function
, thisArg
?:
S
)
:
T
|
undefined
Type parameters
T
S
Parameters
callback:
function
(
this
:
S
, key
:
K
, value
:
V
, downlink
:
MapDownlink
<
K
,
V
,
KU
,
VU
>
)
:
T
|
void
Parameters
this:
S
key:
K
value:
V
downlink:
MapDownlink
<
K
,
V
,
KU
,
VU
>
Returns
T
|
void
Optional
thisArg:
S
Returns
T
|
undefined
get
get
(
)
:
MapDownlink
<
K
,
V
,
KU
,
VU
>
get
(
key
:
KU
)
:
V
Returns
MapDownlink
<
K
,
V
,
KU
,
VU
>
Parameters
key:
KU
Returns
V
get
Entry
get
Entry
(
index
:
number
)
:
[
K
,
V
]
|
undefined
Parameters
index:
number
Returns
[
K
,
V
]
|
undefined
has
has
(
key
:
KU
)
:
boolean
Parameters
key:
KU
Returns
boolean
host
Uri
host
Uri
(
)
:
Uri
host
Uri
(
hostUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
hostUri:
AnyUri
Returns
this
initial
State
initial
State
(
)
:
BTree
<
Value
,
Value
>
|
null
initial
State
(
state0
:
BTree
<
Value
,
Value
>
|
null
)
:
this
Returns
BTree
<
Value
,
Value
>
|
null
Parameters
state0:
BTree
<
Value
,
Value
>
|
null
Returns
this
input
input
(
)
:
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
|
null
Returns
MapOutlet
<
K
,
V
,
Map
<
K
,
V
>
>
|
null
invalidate
invalidate
(
)
:
void
Returns
void
invalidate
Input
invalidate
Input
(
)
:
void
Returns
void
invalidate
Input
Key
invalidate
Input
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
invalidate
Key
invalidate
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
invalidate
Output
invalidate
Output
(
)
:
void
Returns
void
invalidate
Output
Key
invalidate
Output
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
is
Authenticated
is
Authenticated
(
)
:
boolean
Returns
boolean
is
Connected
is
Connected
(
)
:
boolean
Returns
boolean
is
Empty
is
Empty
(
)
:
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
)
:
this
Returns
boolean
Parameters
keepLinked:
boolean
Returns
this
keep
Synced
keep
Synced
(
)
:
boolean
keep
Synced
(
keepSynced
:
boolean
)
:
this
Returns
boolean
Parameters
keepSynced:
boolean
Returns
this
key
Form
key
Form
(
)
:
Form
<
K
,
KU
>
key
Form<K2, K2U>
(
keyForm
:
Form
<
K2
,
K2U
>
)
:
MapDownlink
<
K2
,
V
,
K2U
,
VU
>
Returns
Form
<
K
,
KU
>
Type parameters
K2
:
K2U
K2U
Parameters
keyForm:
Form
<
K2
,
K2U
>
Returns
MapDownlink
<
K2
,
V
,
K2U
,
VU
>
key
Iterator
key
Iterator
(
)
:
Cursor
<
K
>
Returns
Cursor
<
K
>
keys
keys
(
)
:
Cursor
<
K
>
Returns
Cursor
<
K
>
lane
Uri
lane
Uri
(
)
:
Uri
lane
Uri
(
laneUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
laneUri:
AnyUri
Returns
this
last
Entry
last
Entry
(
)
:
[
K
,
V
]
|
undefined
Returns
[
K
,
V
]
|
undefined
last
Key
last
Key
(
)
:
K
|
undefined
Returns
K
|
undefined
last
Value
last
Value
(
)
:
V
|
undefined
Returns
V
|
undefined
map
map<O2>
(
func
:
MapValueFunction
<
MapDownlink
<
K
,
V
,
KU
,
VU
>
,
O2
>
)
:
Outlet
<
O2
>
map<V2>
(
func
:
MapFieldValuesFunction
<
K
,
V
,
V2
>
)
:
MapOutlet
<
K
,
V2
,
Map
<
K
,
V2
>
>
Type parameters
O2
Parameters
func:
MapValueFunction
<
MapDownlink
<
K
,
V
,
KU
,
VU
>
,
O2
>
Returns
Outlet
<
O2
>
Type parameters
V2
Parameters
func:
MapFieldValuesFunction
<
K
,
V
,
V2
>
Returns
MapOutlet
<
K
,
V2
,
Map
<
K
,
V2
>
>
memoize
memoize
(
)
:
MapOutlet
<
K
,
V
,
MapDownlink
<
K
,
V
,
KU
,
VU
>
>
Returns
MapOutlet
<
K
,
V
,
MapDownlink
<
K
,
V
,
KU
,
VU
>
>
next
Entry
next
Entry
(
keyObject
:
K
)
:
[
K
,
V
]
|
undefined
Parameters
keyObject:
K
Returns
[
K
,
V
]
|
undefined
next
Key
next
Key
(
keyObject
:
K
)
:
K
|
undefined
Parameters
keyObject:
K
Returns
K
|
undefined
next
Value
next
Value
(
keyObject
:
K
)
:
V
|
undefined
Parameters
keyObject:
K
Returns
V
|
undefined
node
Uri
node
Uri
(
)
:
Uri
node
Uri
(
nodeUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
nodeUri:
AnyUri
Returns
this
observe
observe
(
observer
:
MapDownlinkObserver
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
observer:
MapDownlinkObserver
<
K
,
V
,
KU
,
VU
>
Returns
this
on
Command
on
Command
(
onCommand
:
DownlinkOnCommand
)
:
this
Parameters
onCommand:
DownlinkOnCommand
Returns
this
on
Event
on
Event
(
onEvent
:
DownlinkOnEvent
)
:
this
Parameters
onEvent:
DownlinkOnEvent
Returns
this
Protected
on
Invalidate
on
Invalidate
(
)
:
void
Returns
void
Protected
on
Invalidate
Key
on
Invalidate
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
Protected
on
Reconcile
on
Reconcile
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
Protected
on
Reconcile
Key
on
Reconcile
Key
(
key
:
K
, effect
:
KeyEffect
, version
:
number
)
:
void
Parameters
key:
K
effect:
KeyEffect
version:
number
Returns
void
open
open
(
)
:
this
Returns
this
outlet
outlet
(
key
:
K
)
:
Outlet
<
V
>
Parameters
key:
K
Returns
Outlet
<
V
>
output
Iterator
output
Iterator
(
)
:
Cursor
<
Inlet
<
MapDownlink
<
K
,
V
>
>
>
Returns
Cursor
<
Inlet
<
MapDownlink
<
K
,
V
>
>
>
previous
Entry
previous
Entry
(
keyObject
:
K
)
:
[
K
,
V
]
|
undefined
Parameters
keyObject:
K
Returns
[
K
,
V
]
|
undefined
previous
Key
previous
Key
(
keyObject
:
K
)
:
K
|
undefined
Parameters
keyObject:
K
Returns
K
|
undefined
previous
Value
previous
Value
(
keyObject
:
K
)
:
V
|
undefined
Parameters
keyObject:
K
Returns
V
|
undefined
prio
prio
(
)
:
number
prio
(
prio
:
number
)
:
this
Returns
number
Parameters
prio:
number
Returns
this
rate
rate
(
)
:
number
rate
(
rate
:
number
)
:
this
Returns
number
Parameters
rate:
number
Returns
this
reconcile
reconcile
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
reconcile
Input
reconcile
Input
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
reconcile
Input
Key
reconcile
Input
Key
(
key
:
K
, version
:
number
)
:
void
Parameters
key:
K
version:
number
Returns
void
reconcile
Key
reconcile
Key
(
key
:
K
, version
:
number
)
:
void
Parameters
key:
K
version:
number
Returns
void
reconcile
Output
reconcile
Output
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
reconcile
Output
Key
reconcile
Output
Key
(
key
:
K
, version
:
number
)
:
void
Parameters
key:
K
version:
number
Returns
void
reduce
reduce<U>
(
identity
:
U
, accumulator
:
function
, combiner
:
function
)
:
Outlet
<
U
>
Type parameters
U
Parameters
identity:
U
accumulator:
function
(
result
:
U
, element
:
V
)
:
U
Parameters
result:
U
element:
V
Returns
U
combiner:
function
(
result
:
U
, result2
:
U
)
:
U
Parameters
result:
U
result2:
U
Returns
U
Returns
Outlet
<
U
>
session
session
(
)
:
Value
Returns
Value
set
set
(
key
:
KU
, newValue
:
VU
)
:
this
Parameters
key:
KU
newValue:
VU
Returns
this
set
State
set
State
(
state
:
BTree
<
Value
,
Value
>
)
:
void
Parameters
state:
BTree
<
Value
,
Value
>
Returns
void
snapshot
snapshot
(
)
:
BTree
<
Value
,
Value
>
Returns
BTree
<
Value
,
Value
>
take
take
(
upper
:
number
)
:
this
Parameters
upper:
number
Returns
this
type
type
(
)
:
DownlinkType
Returns
DownlinkType
unbind
Input
unbind
Input
(
)
:
void
Returns
void
unbind
Output
unbind
Output
(
output
:
Inlet
<
MapDownlink
<
K
,
V
>
>
)
:
void
Parameters
output:
Inlet
<
MapDownlink
<
K
,
V
>
>
Returns
void
unbind
Outputs
unbind
Outputs
(
)
:
void
Returns
void
unobserve
unobserve
(
observer
:
unknown
)
:
this
Parameters
observer:
unknown
Returns
this
value
Form
value
Form
(
)
:
Form
<
V
,
VU
>
value
Form<V2, V2U>
(
valueForm
:
Form
<
V2
,
V2U
>
)
:
MapDownlink
<
K
,
V2
,
KU
,
V2U
>
Returns
Form
<
V
,
VU
>
Type parameters
V2
:
V2U
V2U
Parameters
valueForm:
Form
<
V2
,
V2U
>
Returns
MapDownlink
<
K
,
V2
,
KU
,
V2U
>
values
values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
watch
watch
(
func
:
WatchValueFunction
<
MapDownlink
<
K
,
V
,
KU
,
VU
>
>
)
:
this
watch
(
func
:
WatchFieldsFunction
<
K
,
V
>
)
:
this
Parameters
func:
WatchValueFunction
<
MapDownlink
<
K
,
V
,
KU
,
VU
>
>
Returns
this
Parameters
func:
WatchFieldsFunction
<
K
,
V
>
Returns
this
will
Clear
will
Clear
(
willClear
:
MapDownlinkWillClear
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
willClear:
MapDownlinkWillClear
<
K
,
V
,
KU
,
VU
>
Returns
this
will
Drop
will
Drop
(
willDrop
:
MapDownlinkWillDrop
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
willDrop:
MapDownlinkWillDrop
<
K
,
V
,
KU
,
VU
>
Returns
this
Protected
will
Invalidate
will
Invalidate
(
)
:
void
Returns
void
Protected
will
Invalidate
Key
will
Invalidate
Key
(
key
:
K
, effect
:
KeyEffect
)
:
void
Parameters
key:
K
effect:
KeyEffect
Returns
void
will
Link
will
Link
(
willLink
:
DownlinkWillLink
)
:
this
Parameters
willLink:
DownlinkWillLink
Returns
this
Protected
will
Reconcile
will
Reconcile
(
version
:
number
)
:
void
Parameters
version:
number
Returns
void
Protected
will
Reconcile
Key
will
Reconcile
Key
(
key
:
K
, effect
:
KeyEffect
, version
:
number
)
:
void
Parameters
key:
K
effect:
KeyEffect
version:
number
Returns
void
will
Remove
will
Remove
(
willRemove
:
MapDownlinkWillRemove
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
willRemove:
MapDownlinkWillRemove
<
K
,
V
,
KU
,
VU
>
Returns
this
will
Sync
will
Sync
(
willSync
:
DownlinkWillSync
)
:
this
Parameters
willSync:
DownlinkWillSync
Returns
this
will
Take
will
Take
(
willTake
:
MapDownlinkWillTake
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
willTake:
MapDownlinkWillTake
<
K
,
V
,
KU
,
VU
>
Returns
this
will
Unlink
will
Unlink
(
willUnlink
:
DownlinkWillUnlink
)
:
this
Parameters
willUnlink:
DownlinkWillUnlink
Returns
this
will
Update
will
Update
(
willUpdate
:
MapDownlinkWillUpdate
<
K
,
V
,
KU
,
VU
>
)
:
this
Parameters
willUpdate:
MapDownlinkWillUpdate
<
K
,
V
,
KU
,
VU
>
Returns
this
Static
init
Form
init
Form
(
)
:
Form
<
DownlinkInit
|
undefined
>
Returns
Form
<
DownlinkInit
|
undefined
>
Globals
@swim/core
@swim/mesh
@swim/client
@swim/warp
@swim/ui
@swim/ux
@swim/web
Map
Downlink
size
bind
Input
bind
Output
body
clear
close
command
copy
delete
did
Clear
did
Close
did
Connect
did
Disconnect
did
Drop
did
Fail
did
Invalidate
did
Invalidate
Key
did
Link
did
Reconcile
did
Reconcile
Key
did
Remove
did
Sync
did
Take
did
Unlink
did
Update
disconnect
Inputs
disconnect
Outputs
drop
entries
filter
first
Entry
first
Key
first
Value
for
Each
get
get
Entry
has
host
Uri
initial
State
input
invalidate
invalidate
Input
invalidate
Input
Key
invalidate
Key
invalidate
Output
invalidate
Output
Key
is
Authenticated
is
Connected
is
Empty
is
Linked
is
Synced
keep
Linked
keep
Synced
key
Form
key
Iterator
keys
lane
Uri
last
Entry
last
Key
last
Value
map
memoize
next
Entry
next
Key
next
Value
node
Uri
observe
on
Command
on
Event
on
Invalidate
on
Invalidate
Key
on
Reconcile
on
Reconcile
Key
open
outlet
output
Iterator
previous
Entry
previous
Key
previous
Value
prio
rate
reconcile
reconcile
Input
reconcile
Input
Key
reconcile
Key
reconcile
Output
reconcile
Output
Key
reduce
session
set
set
State
snapshot
take
type
unbind
Input
unbind
Output
unbind
Outputs
unobserve
value
Form
values
watch
will
Clear
will
Drop
will
Invalidate
will
Invalidate
Key
will
Link
will
Reconcile
will
Reconcile
Key
will
Remove
will
Sync
will
Take
will
Unlink
will
Update
init
Form