Interface ModelDownlink<M>

Type parameters

M: ModelDownlinkContext

Hierarchy

ModelDownlink

Index

Properties

Methods

Properties

Optional consume

consume: boolean

Readonly downlink

downlink: null | Downlink

Readonly downlinkConsumers

downlinkConsumers: readonly unknown[]

Readonly downlinkFlags

downlinkFlags: number

Readonly name

name: undefined | string

Readonly ownBody

ownBody: null | Value

Readonly ownHostUri

ownHostUri: null | Uri

Readonly ownLaneUri

ownLaneUri: null | Uri

Readonly ownNodeUri

ownNodeUri: null | Uri

Readonly ownPrio

ownPrio: undefined | number

Readonly ownRate

ownRate: undefined | number

Readonly ownWarp

ownWarp: null | WarpRef

Readonly owner

owner: M

Methods

addDownlinkConsumer

addDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:59
Parameters
- downlinkConsumer: unknown
Returns void

bindDownlink

bindDownlink(downlink: Downlink): Downlink

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:93
Parameters
- downlink: Downlink
Returns Downlink

body

body(): null | Value
body(body: AnyValue): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:86
Returns null | Value
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:87
Parameters
- body: AnyValue
Returns ModelDownlink<M>

createDownlink

createDownlink(warp: WarpRef): Downlink

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:92
Parameters
- warp: WarpRef
Returns Downlink

didAddDownlinkConsumer

didAddDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:62
Parameters
- downlinkConsumer: unknown
Returns void

didMount

didMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:105
Returns void

didRemoveDownlinkConsumer

didRemoveDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:66
Parameters
- downlinkConsumer: unknown
Returns void

didStartConsuming

didStartConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:53
Returns void

didStopConsuming

didStopConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:57
Returns void

didUnmount

didUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:109
Returns void

hostUri

hostUri(): null | Uri
hostUri(hostUri: null | AnyUri): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:71
Returns null | Uri
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:72
Parameters
- hostUri: null | AnyUri
Returns ModelDownlink<M>

Optional initBody

initBody(): AnyValue

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:100
Returns AnyValue

Optional initDownlink

initDownlink(downlink: Downlink): Downlink

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:94
Parameters
- downlink: Downlink
Returns Downlink

Optional initHostUri

initHostUri(): null | AnyUri

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:95
Returns null | AnyUri

Optional initLaneUri

initLaneUri(): null | AnyUri

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:97
Returns null | AnyUri

Optional initNodeUri

initNodeUri(): null | AnyUri

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:96
Returns null | AnyUri

Optional initPrio

initPrio(): undefined | number

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:98
Returns undefined | number

Optional initRate

initRate(): undefined | number

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:99
Returns undefined | number

isConsuming

isConsuming(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:49
Returns boolean

isMounted

isMounted(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:101
Returns boolean

laneUri

laneUri(): null | Uri
laneUri(laneUri: null | AnyUri): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:77
Returns null | Uri
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:78
Parameters
- laneUri: null | AnyUri
Returns ModelDownlink<M>

link

link(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:88
Returns void

mount

mount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:102
Returns void

nodeUri

nodeUri(): null | Uri
nodeUri(nodeUri: null | AnyUri): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:74
Returns null | Uri
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:75
Parameters
- nodeUri: null | AnyUri
Returns ModelDownlink<M>

onAddDownlinkConsumer

onAddDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:61
Parameters
- downlinkConsumer: unknown
Returns void

onMount

onMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:104
Returns void

onRemoveDownlinkConsumer

onRemoveDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:65
Parameters
- downlinkConsumer: unknown
Returns void

onStartConsuming

onStartConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:52
Returns void

onStopConsuming

onStopConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:56
Returns void

onUnmount

onUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:108
Returns void

prio

prio(): undefined | number
prio(prio: undefined | number): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:80
Returns undefined | number
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:81
Parameters
- prio: undefined | number
Returns ModelDownlink<M>

rate

rate(): undefined | number
rate(rate: undefined | number): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:83
Returns undefined | number
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:84
Parameters
- rate: undefined | number
Returns ModelDownlink<M>

reconcile

reconcile(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:91
Returns void

relink

relink(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:90
Returns void

removeDownlinkConsumer

removeDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:63
Parameters
- downlinkConsumer: unknown
Returns void

setDownlinkFlags

setDownlinkFlags(downlinkFlags: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:47
Parameters
- downlinkFlags: number
Returns void

startConsuming

startConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:50
Returns void

stopConsuming

stopConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:54
Returns void

unlink

unlink(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:89
Returns void

unmount

unmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:106
Returns void

warp

warp(): null | WarpRef
warp(warp: null | WarpRef): ModelDownlink<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:68
Returns null | WarpRef
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:69
Parameters
- warp: null | WarpRef
Returns ModelDownlink<M>

willAddDownlinkConsumer

willAddDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:60
Parameters
- downlinkConsumer: unknown
Returns void

willMount

willMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:103
Returns void

willRemoveDownlinkConsumer

willRemoveDownlinkConsumer(downlinkConsumer: unknown): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:64
Parameters
- downlinkConsumer: unknown
Returns void

willStartConsuming

willStartConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:51
Returns void

willStopConsuming

willStopConsuming(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:55
Returns void

willUnmount

willUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/downlink/ModelDownlink.d.ts:107
Returns void

Generated using TypeDoc