Class ValueDownlink<V, VU>

Type parameters

V: VU
VU

Hierarchy

Downlink
- ValueDownlink

Implements

Inlet<V>
Outlet<V>

Index

Methods

Methods

bindInput

bindInput(input: Outlet<V> | null): void

Implementation of Inlet.bindInput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:230
Parameters
- input: Outlet<V> | null
Returns void

bindOutput

bindOutput(output: Inlet<V>): void

Implementation of Outlet.bindOutput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:260
Parameters
- output: Inlet<V>
Returns void

body

body(): Value
body(body: AnyValue): this

Inherited from Downlink.body
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:210
Returns Value
Inherited from Downlink.body
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:211
Parameters
- body: AnyValue
Returns this

close

close(): void

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

command

command(body: AnyValue): void

Inherited from Downlink.command
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:493
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<ValueDownlinkObserver<V, VU>> | null, valueForm?: Form<V, VU>, state0?: Value): this

Overrides Downlink.copy
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:74
Parameters
- context: DownlinkContext
- owner: DownlinkOwner | undefined
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
- prio: number
- rate: number
- body: Value
- flags: number
- observers: ReadonlyArray<ValueDownlinkObserver<V, VU>> | null
- Optional valueForm: Form<V, VU>
- Optional state0: Value
Returns this

didClose

didClose(didClose: DownlinkDidClose): this

Inherited from Downlink.didClose
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:333
Parameters
- didClose: DownlinkDidClose
Returns this

didConnect

didConnect(didConnect: DownlinkDidConnect): this

Inherited from Downlink.didConnect
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:325
Parameters
- didConnect: DownlinkDidConnect
Returns this

didDisconnect

didDisconnect(didDisconnect: DownlinkDidDisconnect): this

Inherited from Downlink.didDisconnect
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:329
Parameters
- didDisconnect: DownlinkDidDisconnect
Returns this

didFail

didFail(didFail: DownlinkDidFail): this

Inherited from Downlink.didFail
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:337
Parameters
- didFail: DownlinkDidFail
Returns this

Protected didInvalidate

didInvalidate(): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:368
Returns void

didLink

didLink(didLink: DownlinkDidLink): this

Inherited from Downlink.didLink
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:305
Parameters
- didLink: DownlinkDidLink
Returns this

Protected didReconcile

didReconcile(version: number): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:385
Parameters
- version: number
Returns void

didSet

didSet(didSet: VaueDownlinkDidSet<V, VU>): this

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:125
Parameters
- didSet: VaueDownlinkDidSet<V, VU>
Returns this

didSync

didSync(didSync: DownlinkDidSync): this

Inherited from Downlink.didSync
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:313
Parameters
- didSync: DownlinkDidSync
Returns this

didUnlink

didUnlink(didUnlink: DownlinkDidUnlink): this

Inherited from Downlink.didUnlink
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:321
Parameters
- didUnlink: DownlinkDidUnlink
Returns this

disconnectInputs

disconnectInputs(): void

Implementation of Outlet.disconnectInputs
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:247
Returns void

disconnectOutputs

disconnectOutputs(): void

Implementation of Outlet.disconnectOutputs
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:303
Returns void

get

get(): V

Implementation of Outlet.get
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:102
Returns V

hostUri

hostUri(): Uri
hostUri(hostUri: AnyUri): this

Inherited from Downlink.hostUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:152
Returns Uri
Inherited from Downlink.hostUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:153
Parameters
- hostUri: AnyUri
Returns this

initialState

initialState(): Value
initialState(state0: Value): this

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:172
Returns Value
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:173
Parameters
- state0: Value
Returns this

input

input(): Outlet<V> | null

Implementation of Inlet.input
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:226
Returns Outlet<V> | null

invalidate

invalidate(): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:323
Returns void

invalidateInput

invalidateInput(): void

Implementation of Outlet.invalidateInput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:319
Returns void

invalidateOutput

invalidateOutput(): void

Implementation of Inlet.invalidateOutput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:315
Returns void

isAuthenticated

isAuthenticated(): boolean

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

isConnected

isConnected(): boolean

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

isLinked

isLinked(): boolean

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

isSynced

isSynced(): boolean

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

keepLinked

keepLinked(): boolean
keepLinked(keepLinked: boolean): this

Inherited from Downlink.keepLinked
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:224
Returns boolean
Inherited from Downlink.keepLinked
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:225
Parameters
- keepLinked: boolean
Returns this

keepSynced

keepSynced(): boolean
keepSynced(keepSynced: boolean): this

Inherited from Downlink.keepSynced
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:236
Returns boolean
Inherited from Downlink.keepSynced
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:237
Parameters
- keepSynced: boolean
Returns this

laneUri

laneUri(): Uri
laneUri(laneUri: AnyUri): this

Inherited from Downlink.laneUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:176
Returns Uri
Inherited from Downlink.laneUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:177
Parameters
- laneUri: AnyUri
Returns this

map

map<V2>(func: MapValueFunction<V, V2>): Outlet<V2>

Implementation of Outlet.map
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:393
Type parameters
- V2
Parameters
- func: MapValueFunction<V, V2>
Returns Outlet<V2>

memoize

memoize(): Outlet<V>

Implementation of Outlet.memoize
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:389
Returns Outlet<V>

nodeUri

nodeUri(): Uri
nodeUri(nodeUri: AnyUri): this

Inherited from Downlink.nodeUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:164
Returns Uri
Inherited from Downlink.nodeUri
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:165
Parameters
- nodeUri: AnyUri
Returns this

observe

observe(observer: ValueDownlinkObserver<V, VU>): this

Overrides Downlink.observe
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:117
Parameters
- observer: ValueDownlinkObserver<V, VU>
Returns this

onCommand

onCommand(onCommand: DownlinkOnCommand): this

Inherited from Downlink.onCommand
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:297
Parameters
- onCommand: DownlinkOnCommand
Returns this

onEvent

onEvent(onEvent: DownlinkOnEvent): this

Inherited from Downlink.onEvent
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:293
Parameters
- onEvent: DownlinkOnEvent
Returns this

Protected onInvalidate

onInvalidate(): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:364
Returns void

Protected onReconcile

onReconcile(version: number): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:376
Parameters
- version: number
Returns void

open

open(): this

Overrides Downlink.open
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:191
Returns this

outputIterator

outputIterator(): Cursor<Inlet<V>>

Implementation of Outlet.outputIterator
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:256
Returns Cursor<Inlet<V>>

prio

prio(): number
prio(prio: number): this

Inherited from Downlink.prio
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:188
Returns number
Inherited from Downlink.prio
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:189
Parameters
- prio: number
Returns this

rate

rate(): number
rate(rate: number): this

Inherited from Downlink.rate
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:199
Returns number
Inherited from Downlink.rate
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:200
Parameters
- rate: number
Returns this

reconcile

reconcile(version: number): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:344
Parameters
- version: number
Returns void

reconcileInput

reconcileInput(version: number): void

Implementation of Outlet.reconcileInput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:340
Parameters
- version: number
Returns void

reconcileOutput

reconcileOutput(version: number): void

Implementation of Inlet.reconcileOutput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:336
Parameters
- version: number
Returns void

session

session(): Value

Inherited from Downlink.session
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:357
Returns Value

set

set(newObject: VU): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:108
Parameters
- newObject: VU
Returns void

setState

setState(state: Value): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:113
Parameters
- state: Value
Returns void

type

type(): DownlinkType

Overrides Downlink.type
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:86
Returns DownlinkType

unbindInput

unbindInput(): void

Implementation of Inlet.unbindInput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:240
Returns void

unbindOutput

unbindOutput(output: Inlet<V>): void

Implementation of Outlet.unbindOutput
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:271
Parameters
- output: Inlet<V>
Returns void

unbindOutputs

unbindOutputs(): void

Implementation of Outlet.unbindOutputs
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:293
Returns void

unobserve

unobserve(observer: unknown): this

Inherited from Downlink.unobserve
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:260
Parameters
- observer: unknown
Returns this

valueForm

valueForm(): Form<V, VU>
valueForm<V2, V2U>(valueForm: Form<V2, V2U>): ValueDownlink<V2, V2U>

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:90
Returns Form<V, VU>
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:91
Type parameters
- V2: V2U
- V2U
Parameters
- valueForm: Form<V2, V2U>
Returns ValueDownlink<V2, V2U>

watch

watch(func: WatchValueFunction<V>): this

Implementation of Outlet.watch
- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:399
Parameters
- func: WatchValueFunction<V>
Returns this

Protected willInvalidate

willInvalidate(): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:360
Returns void

willLink

willLink(willLink: DownlinkWillLink): this

Inherited from Downlink.willLink
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:301
Parameters
- willLink: DownlinkWillLink
Returns this

Protected willReconcile

willReconcile(version: number): void

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:372
Parameters
- version: number
Returns void

willSet

willSet(willSet: ValueDownlinkWillSet<V, VU>): this

- Defined in swim-mesh-js/@swim/client/main/downlink/ValueDownlink.ts:121
Parameters
- willSet: ValueDownlinkWillSet<V, VU>
Returns this

willSync

willSync(willSync: DownlinkWillSync): this

Inherited from Downlink.willSync
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:309
Parameters
- willSync: DownlinkWillSync
Returns this

willUnlink

willUnlink(willUnlink: DownlinkWillUnlink): this

Inherited from Downlink.willUnlink
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:317
Parameters
- willUnlink: DownlinkWillUnlink
Returns this

Static initForm

initForm(): Form<DownlinkInit | undefined>

Inherited from Downlink.initForm
- Defined in swim-mesh-js/@swim/client/main/downlink/Downlink.ts:527
Returns Form<DownlinkInit | undefined>