Class MapDownlink<K, V, KU, VU>

Type parameters

K
V
KU = never
VU = never

Hierarchy

Downlink
MapOutletCombinators<K, V, MapDownlink<K, V, KU, VU>>
- MapDownlink

Implements

OrderedMap<K, V>
MapInlet<K, V, Map<K, V>>
MapOutlet<K, V, MapDownlink<K, V, KU, VU>>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MapDownlink<K, V, KU, VU>(context: DownlinkContext, owner: null | DownlinkOwner, init?: MapDownlinkInit<K, V, KU, VU>, hostUri?: Uri, nodeUri?: Uri, laneUri?: Uri, prio?: number, rate?: number, body?: Value, flags?: number, observers?: MapDownlinkObserver<K, V, KU, VU> | readonly MapDownlinkObserver<K, V, KU, VU>[], keyForm?: Form<K, KU>, valueForm?: Form<V, VU>, state0?: null | BTree<Value, Value, never>): MapDownlink<K, V, KU, VU>

Overrides Downlink.constructor
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:36
Type parameters
- K
- V
- KU = never
- VU = never
Parameters
- context: DownlinkContext
- owner: null | DownlinkOwner
- Optional init: MapDownlinkInit<K, V, KU, VU>
- Optional hostUri: Uri
- Optional nodeUri: Uri
- Optional laneUri: Uri
- Optional prio: number
- Optional rate: number
- Optional body: Value
- Optional flags: number
- Optional observers: MapDownlinkObserver<K, V, KU, VU> | readonly MapDownlinkObserver<K, V, KU, VU>[]
- Optional keyForm: Form<K, KU>
- Optional valueForm: Form<V, VU>
- Optional state0: null | BTree<Value, Value, never>
Returns MapDownlink<K, V, KU, VU>

Properties

Readonly context

context: DownlinkContext

Readonly effects

effects: BTree<K, KeyEffect, never>

Readonly flags

flags: number

Readonly input

input: null | MapOutlet<K, V, Map<K, V>>

Readonly model

model: null | MapDownlinkModel

Readonly observers

observers: readonly MapDownlinkObserver<K, V, KU, VU>[]

Readonly outlets

outlets: BTree<K, KeyOutlet<K, V>, never>

Readonly outputs

outputs: readonly Inlet<MapDownlink<K, V, KU, VU>>[]

Readonly ownBody

ownBody: Value

Readonly ownHostUri

ownHostUri: Uri

Readonly ownKeyForm

ownKeyForm: Form<K, KU>

Readonly ownLaneUri

ownLaneUri: Uri

Readonly ownNodeUri

ownNodeUri: Uri

Readonly ownPrio

ownPrio: number

Readonly ownRate

ownRate: number

Readonly ownValueForm

ownValueForm: Form<V, VU>

Readonly owner

owner: null | DownlinkOwner

Readonly state0

state0: null | BTree<Value, Value, never>

Readonly version

version: number

Accessors

session

get session(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:98
Returns Value

size

get size(): number

Implementation of OrderedMap.size
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:49
Returns number

type

get type(): DownlinkType

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:43
Returns DownlinkType

Methods

bindInput

bindInput(newInput: MapOutlet<K, V, Map<K, V>>): void

Implementation of MapInlet.bindInput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:110
Parameters
- newInput: MapOutlet<K, V, Map<K, V>>
Returns void

bindOutput

bindOutput(output: Inlet<MapDownlink<K, V, KU, VU>>): void

Implementation of MapOutlet.bindOutput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:115
Parameters
- output: Inlet<MapDownlink<K, V, KU, VU>>
Returns void

body

body(): Value
body(body: AnyValue): MapDownlink<K, V, KU, VU>

Inherited from Downlink.body
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:155
Returns Value
Inherited from Downlink.body
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:156
Parameters
- body: AnyValue
Returns MapDownlink<K, V, KU, VU>

clear

clear(): void

Implementation of OrderedMap.clear
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:71
Returns void

close

close(): void

Inherited from Downlink.close
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:112
Returns void

closeUp

closeUp(): void

Inherited from Downlink.closeUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:114
Returns void

command

command(body: AnyValue): void

Inherited from Downlink.command
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:110
Parameters
- body: AnyValue
Returns void

Protected copy

copy<K, V, KU, VU>(context: DownlinkContext, owner: null | DownlinkOwner, hostUri: Uri, nodeUri: Uri, laneUri: Uri, prio: number, rate: number, body: Value, flags: number, observers: readonly MapDownlinkObserver<K, V, KU, VU>[], keyForm?: Form<K, KU>, valueForm?: Form<V, VU>, state0?: null | BTree<Value, Value, never>): MapDownlink<K, V, KU, VU>

Overrides Downlink.copy
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:44
Type parameters
- K
- V
- KU
- VU
Parameters
- context: DownlinkContext
- owner: null | DownlinkOwner
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
- prio: number
- rate: number
- body: Value
- flags: number
- observers: readonly MapDownlinkObserver<K, V, KU, VU>[]
- Optional keyForm: Form<K, KU>
- Optional valueForm: Form<V, VU>
- Optional state0: null | BTree<Value, Value, never>
Returns MapDownlink<K, V, KU, VU>

decohere

decohere(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:124
Returns void

decohereInput

decohereInput(): void

Implementation of MapOutlet.decohereInput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:123
Returns void

decohereInputKey

decohereInputKey(key: K, effect: KeyEffect): void

Implementation of MapOutlet.decohereInputKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:120
Parameters
- key: K
- effect: KeyEffect
Returns void

decohereKey

decohereKey(key: K, effect: KeyEffect): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:121
Parameters
- key: K
- effect: KeyEffect
Returns void

decohereOutput

decohereOutput(): void

Implementation of MapInlet.decohereOutput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:122
Returns void

decohereOutputKey

decohereOutputKey(key: K, effect: KeyEffect): void

Implementation of MapInlet.decohereOutputKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:119
Parameters
- key: K
- effect: KeyEffect
Returns void

delete

delete(key: K | KU): boolean

Implementation of OrderedMap.delete
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:68
Parameters
- key: K | KU
Returns boolean

Protected didAliasModel

didAliasModel(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:102
Returns void

didClear

didClear(didClear: MapDownlinkDidClear<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:89
Parameters
- didClear: MapDownlinkDidClear<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

didClose

didClose(didClose: DownlinkDidClose): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didClose
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:92
Parameters
- didClose: DownlinkDidClose
Returns MapDownlink<K, V, KU, VU>

didConnect

didConnect(didConnect: DownlinkDidConnect): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:90
Parameters
- didConnect: DownlinkDidConnect
Returns MapDownlink<K, V, KU, VU>

Protected didDecohere

didDecohere(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:136
Returns void

Protected didDecohereKey

didDecohereKey(key: K, effect: KeyEffect): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:133
Parameters
- key: K
- effect: KeyEffect
Returns void

didDisconnect

didDisconnect(didDisconnect: DownlinkDidDisconnect): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:91
Parameters
- didDisconnect: DownlinkDidDisconnect
Returns MapDownlink<K, V, KU, VU>

didDrop

didDrop(didDrop: MapDownlinkDidDrop<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:85
Parameters
- didDrop: MapDownlinkDidDrop<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

didFail

didFail(didFail: DownlinkDidFail): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:93
Parameters
- didFail: DownlinkDidFail
Returns MapDownlink<K, V, KU, VU>

didLink

didLink(didLink: DownlinkDidLink): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didLink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:85
Parameters
- didLink: DownlinkDidLink
Returns MapDownlink<K, V, KU, VU>

Protected didRecohere

didRecohere(version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:142
Parameters
- version: number
Returns void

Protected didRecohereKey

didRecohereKey(key: K, effect: KeyEffect, version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:139
Parameters
- key: K
- effect: KeyEffect
- version: number
Returns void

didRemove

didRemove(didRemove: MapDownlinkDidRemove<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:83
Parameters
- didRemove: MapDownlinkDidRemove<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

didSync

didSync(didSync: DownlinkDidSync): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didSync
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:87
Parameters
- didSync: DownlinkDidSync
Returns MapDownlink<K, V, KU, VU>

didTake

didTake(didTake: MapDownlinkDidTake<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:87
Parameters
- didTake: MapDownlinkDidTake<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

didUnlink

didUnlink(didUnlink: DownlinkDidUnlink): MapDownlink<K, V, KU, VU>

Inherited from Downlink.didUnlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:89
Parameters
- didUnlink: DownlinkDidUnlink
Returns MapDownlink<K, V, KU, VU>

didUpdate

didUpdate(didUpdate: MapDownlinkDidUpdate<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:81
Parameters
- didUpdate: MapDownlinkDidUpdate<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

disconnectInputs

disconnectInputs(): void

Implementation of MapInlet.disconnectInputs
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:112
Returns void

disconnectOutputs

disconnectOutputs(): void

Implementation of MapInlet.disconnectOutputs
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:118
Returns void

drop

drop(lower: number): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:69
Parameters
- lower: number
Returns MapDownlink<K, V, KU, VU>

entries

entries(): Cursor<[K, V]>

Implementation of OrderedMap.entries
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:76
Returns Cursor<[K, V]>

filter

filter(func: FilterFieldsFunction<K, V>): MapOutlet<K, V, Map<K, V>>

Implementation of MapOutlet.filter
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:10
Parameters
- func: FilterFieldsFunction<K, V>
Returns MapOutlet<K, V, Map<K, V>>

firstEntry

firstEntry(): undefined | [K, V]

Implementation of OrderedMap.firstEntry
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:57
Returns undefined | [K, V]

firstKey

firstKey(): undefined | K

Implementation of OrderedMap.firstKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:55
Returns undefined | K

firstValue

firstValue(): undefined | V

Implementation of OrderedMap.firstValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:56
Returns undefined | V

forEach

forEach<T>(callback: (key: K, value: V) => void | T): undefined | T
forEach<T, S>(callback: (key: K, value: V) => void | T, thisArg: S): undefined | T

Implementation of OrderedMap.forEach
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:72
Type parameters
- T
Parameters
- callback: (key: K, value: V) => void | T
  - - (key: K, value: V): void | T
    - Parameters
      - key: K
      - value: V
      Returns void | T
Returns undefined | T
Implementation of OrderedMap.forEach
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:73
Type parameters
- T
- S
Parameters
- callback: (key: K, value: V) => void | T
  - - (key: K, value: V): void | T
    - Parameters
      - key: K
      - value: V
      Returns void | T
- thisArg: S
Returns undefined | T

get

get(): MapDownlink<K, V, KU, VU>
get(key: K | KU): V

Implementation of OrderedMap.get
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:52
Returns MapDownlink<K, V, KU, VU>
Implementation of OrderedMap.get
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:53
Parameters
- key: K | KU
Returns V

getEntry

getEntry(index: number): undefined | [K, V]

Implementation of OrderedMap.getEntry
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:54
Parameters
- index: number
Returns undefined | [K, V]

has

has(key: K | KU): boolean

Implementation of OrderedMap.has
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:51
Parameters
- key: K | KU
Returns boolean

hostDidConnect

hostDidConnect(): void

Inherited from Downlink.hostDidConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:107
Returns void

hostDidDisconnect

hostDidDisconnect(): void

Inherited from Downlink.hostDidDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:108
Returns void

hostDidFail

hostDidFail(error: unknown): void

Inherited from Downlink.hostDidFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:109
Parameters
- error: unknown
Returns void

hostUri

hostUri(): Uri
hostUri(hostUri: AnyUri): MapDownlink<K, V, KU, VU>

Inherited from Downlink.hostUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:145
Returns Uri
Inherited from Downlink.hostUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:146
Parameters
- hostUri: AnyUri
Returns MapDownlink<K, V, KU, VU>

initialState

initialState(): null | BTree<Value, Value, never>
initialState(state0: null | BTree<Value, Value, never>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:100
Returns null | BTree<Value, Value, never>
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:101
Parameters
- state0: null | BTree<Value, Value, never>
Returns MapDownlink<K, V, KU, VU>

isAuthenticated

isAuthenticated(): boolean

Inherited from Downlink.isAuthenticated
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:95
Returns boolean

isConnected

isConnected(): boolean

Inherited from Downlink.isConnected
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:94
Returns boolean

isEmpty

isEmpty(): boolean

Implementation of OrderedMap.isEmpty
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:50
Returns boolean

isLinked

isLinked(): boolean

Inherited from Downlink.isLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:96
Returns boolean

isSynced

isSynced(): boolean

Inherited from Downlink.isSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:97
Returns boolean

keepLinked

keepLinked(): boolean
keepLinked(keepLinked: boolean): MapDownlink<K, V, KU, VU>

Inherited from Downlink.keepLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:157
Returns boolean
Inherited from Downlink.keepLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:158
Parameters
- keepLinked: boolean
Returns MapDownlink<K, V, KU, VU>

keepSynced

keepSynced(): boolean
keepSynced(keepSynced: boolean): MapDownlink<K, V, KU, VU>

Inherited from Downlink.keepSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:159
Returns boolean
Inherited from Downlink.keepSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:160
Parameters
- keepSynced: boolean
Returns MapDownlink<K, V, KU, VU>

keyForm

keyForm(): Form<K, KU>
keyForm<K2, K2U>(keyForm: Form<K2, K2U>): MapDownlink<K2, V, K2U, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:45
Returns Form<K, KU>
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:46
Type parameters
- K2
- K2U = never
Parameters
- keyForm: Form<K2, K2U>
Returns MapDownlink<K2, V, K2U, VU>

keyIterator

keyIterator(): Cursor<K>

Implementation of MapOutlet.keyIterator
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:104
Returns Cursor<K>

keys

keys(): Cursor<K>

Implementation of OrderedMap.keys
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:74
Returns Cursor<K>

laneUri

laneUri(): Uri
laneUri(laneUri: AnyUri): MapDownlink<K, V, KU, VU>

Inherited from Downlink.laneUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:149
Returns Uri
Inherited from Downlink.laneUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:150
Parameters
- laneUri: AnyUri
Returns MapDownlink<K, V, KU, VU>

lastEntry

lastEntry(): undefined | [K, V]

Implementation of OrderedMap.lastEntry
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:60
Returns undefined | [K, V]

lastKey

lastKey(): undefined | K

Implementation of OrderedMap.lastKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:58
Returns undefined | K

lastValue

lastValue(): undefined | V

Implementation of OrderedMap.lastValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:59
Returns undefined | V

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>>

Implementation of MapOutlet.map
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:11
Type parameters
- O2
Parameters
- func: MapValueFunction<MapDownlink<K, V, KU, VU>, O2>
Returns Outlet<O2>
Implementation of MapOutlet.map
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:12
Type parameters
- V2
Parameters
- func: MapFieldValuesFunction<K, V, V2>
Returns MapOutlet<K, V2, Map<K, V2>>

mapDidClear

mapDidClear(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:99
Returns void

mapDidDrop

mapDidDrop(lower: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:95
Parameters
- lower: number
Returns void

mapDidRemove

mapDidRemove(key: Value, oldValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:93
Parameters
- key: Value
- oldValue: Value
Returns void

mapDidTake

mapDidTake(upper: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:97
Parameters
- upper: number
Returns void

mapDidUpdate

mapDidUpdate(key: Value, newValue: Value, oldValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:91
Parameters
- key: Value
- newValue: Value
- oldValue: Value
Returns void

mapWillClear

mapWillClear(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:98
Returns void

mapWillDrop

mapWillDrop(lower: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:94
Parameters
- lower: number
Returns void

mapWillRemove

mapWillRemove(key: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:92
Parameters
- key: Value
Returns void

mapWillTake

mapWillTake(upper: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:96
Parameters
- upper: number
Returns void

mapWillUpdate

mapWillUpdate(key: Value, newValue: Value): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:90
Parameters
- key: Value
- newValue: Value
Returns Value

memoize

memoize(): MapOutlet<K, V, MapDownlink<K, V, KU, VU>>

Implementation of MapOutlet.memoize
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:9
Returns MapOutlet<K, V, MapDownlink<K, V, KU, VU>>

nextEntry

nextEntry(keyObject: K): undefined | [K, V]

Implementation of OrderedMap.nextEntry
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:63
Parameters
- keyObject: K
Returns undefined | [K, V]

nextKey

nextKey(keyObject: K): undefined | K

Implementation of OrderedMap.nextKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:61
Parameters
- keyObject: K
Returns undefined | K

nextValue

nextValue(keyObject: K): undefined | V

Implementation of OrderedMap.nextValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:62
Parameters
- keyObject: K
Returns undefined | V

nodeUri

nodeUri(): Uri
nodeUri(nodeUri: AnyUri): MapDownlink<K, V, KU, VU>

Inherited from Downlink.nodeUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:147
Returns Uri
Inherited from Downlink.nodeUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:148
Parameters
- nodeUri: AnyUri
Returns MapDownlink<K, V, KU, VU>

observe

observe(observer: MapDownlinkObserver<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

Overrides Downlink.observe
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:79
Parameters
- observer: MapDownlinkObserver<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

onCommand

onCommand(onCommand: DownlinkOnCommand): MapDownlink<K, V, KU, VU>

Inherited from Downlink.onCommand
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:83
Parameters
- onCommand: DownlinkOnCommand
Returns MapDownlink<K, V, KU, VU>

onCommandMessage

onCommandMessage(body: Value): void

Inherited from Downlink.onCommandMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:100
Parameters
- body: Value
Returns void

Protected onDecohere

onDecohere(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:135
Returns void

Protected onDecohereKey

onDecohereKey(key: K, effect: KeyEffect): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:132
Parameters
- key: K
- effect: KeyEffect
Returns void

onEvent

onEvent(onEvent: DownlinkOnEvent): MapDownlink<K, V, KU, VU>

Inherited from Downlink.onEvent
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:82
Parameters
- onEvent: DownlinkOnEvent
Returns MapDownlink<K, V, KU, VU>

onEventMessage

onEventMessage(message: EventMessage): void

Inherited from Downlink.onEventMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:99
Parameters
- message: EventMessage
Returns void

onLinkRequest

onLinkRequest(request?: LinkRequest): void

Inherited from Downlink.onLinkRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:101
Parameters
- Optional request: LinkRequest
Returns void

onLinkedResponse

onLinkedResponse(response?: LinkedResponse): void

Inherited from Downlink.onLinkedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:102
Parameters
- Optional response: LinkedResponse
Returns void

Protected onRecohere

onRecohere(version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:141
Parameters
- version: number
Returns void

Protected onRecohereKey

onRecohereKey(key: K, effect: KeyEffect, version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:138
Parameters
- key: K
- effect: KeyEffect
- version: number
Returns void

onSyncRequest

onSyncRequest(request?: SyncRequest): void

Inherited from Downlink.onSyncRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:103
Parameters
- Optional request: SyncRequest
Returns void

onSyncedResponse

onSyncedResponse(response?: SyncedResponse): void

Inherited from Downlink.onSyncedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:104
Parameters
- Optional response: SyncedResponse
Returns void

onUnlinkRequest

onUnlinkRequest(request?: UnlinkRequest): void

Inherited from Downlink.onUnlinkRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:105
Parameters
- Optional request: UnlinkRequest
Returns void

onUnlinkedResponse

onUnlinkedResponse(response?: UnlinkedResponse): void

Inherited from Downlink.onUnlinkedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:106
Parameters
- Optional response: UnlinkedResponse
Returns void

open

open(): MapDownlink<K, V, KU, VU>

Overrides Downlink.open
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:103
Returns MapDownlink<K, V, KU, VU>

openUp

openUp(host: Host): void

Inherited from Downlink.openUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:113
Parameters
- host: Host
Returns void

outlet

outlet(key: K): Outlet<V>

Implementation of MapOutlet.outlet
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:113
Parameters
- key: K
Returns Outlet<V>

outputIterator

outputIterator(): Cursor<Inlet<MapDownlink<K, V, KU, VU>>>

Implementation of MapOutlet.outputIterator
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:114
Returns Cursor<Inlet<MapDownlink<K, V, KU, VU>>>

previousEntry

previousEntry(keyObject: K): undefined | [K, V]

Implementation of OrderedMap.previousEntry
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:66
Parameters
- keyObject: K
Returns undefined | [K, V]

previousKey

previousKey(keyObject: K): undefined | K

Implementation of OrderedMap.previousKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:64
Parameters
- keyObject: K
Returns undefined | K

previousValue

previousValue(keyObject: K): undefined | V

Implementation of OrderedMap.previousValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:65
Parameters
- keyObject: K
Returns undefined | V

prio

prio(): number
prio(prio: number): MapDownlink<K, V, KU, VU>

Inherited from Downlink.prio
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:151
Returns number
Inherited from Downlink.prio
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:152
Parameters
- prio: number
Returns MapDownlink<K, V, KU, VU>

rate

rate(): number
rate(rate: number): MapDownlink<K, V, KU, VU>

Inherited from Downlink.rate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:153
Returns number
Inherited from Downlink.rate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:154
Parameters
- rate: number
Returns MapDownlink<K, V, KU, VU>

recohere

recohere(version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:130
Parameters
- version: number
Returns void

recohereInput

recohereInput(version: number): void

Implementation of MapOutlet.recohereInput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:129
Parameters
- version: number
Returns void

recohereInputKey

recohereInputKey(key: K, version: number): void

Implementation of MapOutlet.recohereInputKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:126
Parameters
- key: K
- version: number
Returns void

recohereKey

recohereKey(key: K, version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:127
Parameters
- key: K
- version: number
Returns void

recohereOutput

recohereOutput(version: number): void

Implementation of MapInlet.recohereOutput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:128
Parameters
- version: number
Returns void

recohereOutputKey

recohereOutputKey(key: K, version: number): void

Implementation of MapInlet.recohereOutputKey
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:125
Parameters
- key: K
- version: number
Returns void

reduce

reduce<U>(identity: U, accumulator: (result: U, element: V) => U, combiner: (result: U, result2: U) => U): Outlet<U>

Implementation of MapOutlet.reduce
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:13
Type parameters
- U
Parameters
- identity: U
- accumulator: (result: U, element: V) => U
  - - (result: U, element: V): U
    - Parameters
      - result: U
      - element: V
      Returns U
- combiner: (result: U, result2: U) => U
  - - (result: U, result2: U): U
    - Parameters
      - result: U
      - result2: U
      Returns U
Returns Outlet<U>

set

set(key: K | KU, newValue: V | VU): MapDownlink<K, V, KU, VU>

Implementation of OrderedMap.set
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:67
Parameters
- key: K | KU
- newValue: V | VU
Returns MapDownlink<K, V, KU, VU>

setState

setState(state: BTree<Value, Value, never>): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:78
Parameters
- state: BTree<Value, Value, never>
Returns void

snapshot

snapshot(): BTree<Value, Value, never>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:77
Returns BTree<Value, Value, never>

take

take(upper: number): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:70
Parameters
- upper: number
Returns MapDownlink<K, V, KU, VU>

unbindInput

unbindInput(): void

Implementation of MapInlet.unbindInput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:111
Returns void

unbindOutput

unbindOutput(output: Inlet<MapDownlink<K, V, KU, VU>>): void

Implementation of MapOutlet.unbindOutput
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:116
Parameters
- output: Inlet<MapDownlink<K, V, KU, VU>>
Returns void

unbindOutputs

unbindOutputs(): void

Implementation of MapOutlet.unbindOutputs
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:117
Returns void

unobserve

unobserve(observer: unknown): MapDownlink<K, V, KU, VU>

Inherited from Downlink.unobserve
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:81
Parameters
- observer: unknown
Returns MapDownlink<K, V, KU, VU>

valueForm

valueForm(): Form<V, VU>
valueForm<V2, V2U>(valueForm: Form<V2, V2U>): MapDownlink<K, V2, KU, V2U>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:47
Returns Form<V, VU>
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:48
Type parameters
- V2
- V2U = never
Parameters
- valueForm: Form<V2, V2U>
Returns MapDownlink<K, V2, KU, V2U>

values

values(): Cursor<V>

Implementation of OrderedMap.values
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:75
Returns Cursor<V>

watch

watch(func: WatchValueFunction<MapDownlink<K, V, KU, VU>>): MapDownlink<K, V, KU, VU>
watch(func: WatchFieldsFunction<K, V>): MapDownlink<K, V, KU, VU>

Implementation of MapOutlet.watch
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:14
Parameters
- func: WatchValueFunction<MapDownlink<K, V, KU, VU>>
Returns MapDownlink<K, V, KU, VU>
Implementation of MapOutlet.watch
- Defined in swim-system-js/swim-core-js/@swim/streamlet/lib/main/MapOutletCombinators.d.ts:15
Parameters
- func: WatchFieldsFunction<K, V>
Returns MapDownlink<K, V, KU, VU>

willClear

willClear(willClear: MapDownlinkWillClear<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:88
Parameters
- willClear: MapDownlinkWillClear<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

Protected willDecohere

willDecohere(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:134
Returns void

Protected willDecohereKey

willDecohereKey(key: K, effect: KeyEffect): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:131
Parameters
- key: K
- effect: KeyEffect
Returns void

willDrop

willDrop(willDrop: MapDownlinkWillDrop<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:84
Parameters
- willDrop: MapDownlinkWillDrop<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

willLink

willLink(willLink: DownlinkWillLink): MapDownlink<K, V, KU, VU>

Inherited from Downlink.willLink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:84
Parameters
- willLink: DownlinkWillLink
Returns MapDownlink<K, V, KU, VU>

Protected willRecohere

willRecohere(version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:140
Parameters
- version: number
Returns void

Protected willRecohereKey

willRecohereKey(key: K, effect: KeyEffect, version: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:137
Parameters
- key: K
- effect: KeyEffect
- version: number
Returns void

willRemove

willRemove(willRemove: MapDownlinkWillRemove<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:82
Parameters
- willRemove: MapDownlinkWillRemove<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

willSync

willSync(willSync: DownlinkWillSync): MapDownlink<K, V, KU, VU>

Inherited from Downlink.willSync
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:86
Parameters
- willSync: DownlinkWillSync
Returns MapDownlink<K, V, KU, VU>

willTake

willTake(willTake: MapDownlinkWillTake<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:86
Parameters
- willTake: MapDownlinkWillTake<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

willUnlink

willUnlink(willUnlink: DownlinkWillUnlink): MapDownlink<K, V, KU, VU>

Inherited from Downlink.willUnlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:88
Parameters
- willUnlink: DownlinkWillUnlink
Returns MapDownlink<K, V, KU, VU>

willUpdate

willUpdate(willUpdate: MapDownlinkWillUpdate<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlink.d.ts:80
Parameters
- willUpdate: MapDownlinkWillUpdate<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

Static initForm

initForm(): Form<undefined | DownlinkInit, never>

Inherited from Downlink.initForm
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:115
Returns Form<undefined | DownlinkInit, never>

Generated using TypeDoc