Interface MapDownlink<R, K, V, I>

Type Parameters

R = any
K = Value
V = Value
I extends any[] = [Iterable<[K, V]>]

Hierarchy

WarpDownlink<R, Iterable<[K, V]>, I>
OrderedMap<K, V>
- MapDownlink

Index

Properties

[toStringTag] body coherentTime consumed? hostUri inlet inletVersion keyForm laneUri name nodeUri observerType? owner prio rate valueForm version

Methods

[iterator] attachFastener attachInlets bindInlet callObservers clear close command consume decohere decohereFastener delete detachInlets didBindInlet didClear? didClose didConnect didConsume didDisconnect didDrop? didFail didLink didMount didObserve didRemove? didSetAffinity didSetInherits didStartConsuming didStopConsuming didSync didTake? didUnbindInlet didUnconsume didUnlink didUnmount didUnobserve didUpdate? drop entries firstEntry firstKey firstValue forEach get getBody getEntry getFastener getHostUri getLaneUri getNodeUri getParentFastener getPrio getRate getTransition? has hasAffinity incrementVersion init initBody initHostUri initKeyForm initLaneUri initNodeUri initPrio initRate initValueForm isEmpty keys lastEntry lastKey lastValue nextEntry nextKey nextValue observe onBindInlet onCommand onConsume onEvent onMount onObserve onSetAffinity onSetInherits onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount onUnobserve open previousEntry previousKey previousValue recohere relink requireRecohere requireUpdate resolveInlets set setAffinity setBody setCoherent setCoherentTime setHostUri setInherits setKeyForm setLaneUri setNodeUri setPrio setRate setValueForm snapshot sync take toString unbindInlet unconsume unobserve values willBindInlet willClear? willConsume willDrop? willLink willMount willObserve willRemove? willSetAffinity willSetInherits willStartConsuming willStopConsuming willSync willTake? willUnbindInlet willUnconsume willUnlink willUnmount willUnobserve willUpdate?

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` body

body: Value

`Readonly` coherentTime

coherentTime: number

`Protected` `Optional` `Readonly` consumed

consumed?: boolean

`Readonly` hostUri

hostUri: Uri

`Readonly` inlet

inlet: Fastener<any, any, any> | readonly Fastener<any, any, any>[]

`Readonly` inletVersion

inletVersion: number | readonly number[]

keyForm

keyForm: Form<K, LikeType<K>>

`Readonly` laneUri

laneUri: Uri

`Readonly` name

name: PropertyKey

`Readonly` nodeUri

nodeUri: Uri

`Optional` `Readonly` observerType

observerType?: Class<MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>>

`Readonly` owner

owner: R

`Readonly` prio

prio: number

`Readonly` rate

rate: number

`Readonly` valueForm

valueForm: Form<V, LikeType<V>>

`Readonly` version

version: number

Accessors

affinity

get affinity(): Affinity
Returns Affinity
Inherited from WarpDownlink.affinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:777

authenticated

get authenticated(): boolean
Returns boolean
Inherited from WarpDownlink.authenticated
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:116

binds

get binds(): boolean
Returns boolean
Inherited from WarpDownlink.binds
- Defined in swim-core/swim-component/dist/swim-component.d.ts:723

coherent

get coherent(): boolean
Returns boolean
Inherited from WarpDownlink.coherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:791

connected

get connected(): boolean
Returns boolean
Inherited from WarpDownlink.connected
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:115

consuming

get consuming(): boolean
Returns boolean
Inherited from WarpDownlink.consuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:207

deauthenticated

get deauthenticated(): boolean
Returns boolean
Inherited from WarpDownlink.deauthenticated
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:117

derived

get derived(): boolean
Returns boolean
Inherited from WarpDownlink.derived
- Defined in swim-core/swim-component/dist/swim-component.d.ts:774

descriptorType

get descriptorType(): Proto<MapDownlinkDescriptor<R, K, V>>
Returns Proto<MapDownlinkDescriptor<R, K, V>>
Overrides WarpDownlink.descriptorType
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:41

fastenerType

get fastenerType(): Proto<WarpDownlink<any, any, [any]>>
Returns Proto<WarpDownlink<any, any, [any]>>
Inherited from WarpDownlink.fastenerType
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:72

inheritName

get inheritName(): PropertyKey
Returns PropertyKey
Inherited from WarpDownlink.inheritName
- Defined in swim-core/swim-component/dist/swim-component.d.ts:765

inherits

get inherits(): boolean
Returns boolean
Inherited from WarpDownlink.inherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:766

inletKeys

get inletKeys(): readonly PropertyKey[]
Protected
Returns readonly PropertyKey[]
Inherited from WarpDownlink.inletKeys
- Defined in swim-core/swim-component/dist/swim-component.d.ts:798

linked

get linked(): boolean
Returns boolean
Inherited from WarpDownlink.linked
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:118

mounted

get mounted(): boolean
Returns boolean
Inherited from WarpDownlink.mounted
- Defined in swim-core/swim-component/dist/swim-component.d.ts:820

online

get online(): boolean
Returns boolean
Inherited from WarpDownlink.online
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:114

opened

get opened(): boolean
Returns boolean
Inherited from WarpDownlink.opened
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:113

parent

get parent(): Fastener<any, any, any>
Returns Fastener<any, any, any>
Inherited from WarpDownlink.parent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:739

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from WarpDownlink.parentType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:738

relinks

get relinks(): boolean
Returns boolean
Inherited from WarpDownlink.relinks
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:109

session

get session(): Value
Returns Value
Inherited from WarpDownlink.session
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:120

size

get size(): number
Returns number
Overrides OrderedMap.size
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:60

synced

get synced(): boolean
Returns boolean
Inherited from WarpDownlink.synced
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:119

syncs

get syncs(): boolean
Returns boolean
Inherited from WarpDownlink.syncs
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:111

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>
Inherited from OrderedMap.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

attachFastener

attachFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.attachFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:809

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from WarpDownlink.attachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:801

bindInlet

bindInlet<K, IK>(inlet, key): void
Type Parameters
- K extends string | number | symbol
- IK
Parameters
- inlet: Fastener<any, IK, any>
- key: IK
Returns void
Inherited from WarpDownlink.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:744
bindInlet<I0>(inlet): void
Type Parameters
- I0 extends any
Parameters
- inlet: Fastener<any, I0, any>
Returns void
Inherited from WarpDownlink.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

callObservers

callObservers<R, K>(this, key, ...args): void
Type Parameters
- R
- K extends string | number | symbol
Parameters
- this: {
  observerType?: Class<R>;
  }
  - Optional Readonly observerType?: Class<R>
- key: K
- Rest ...args: ObserverParameters<R, K>
Returns void
Inherited from WarpDownlink.callObservers
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:186

clear

clear(): void
Returns void
Overrides OrderedMap.clear
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:83

close

close(): void
Returns void
Inherited from WarpDownlink.close
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:226

command

command(body): void
Parameters
- body: ValueLike
Returns void
Inherited from WarpDownlink.command
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:121

consume

consume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.consume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:192

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.decohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:794

decohereFastener

decohereFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

delete

delete(key): boolean
Parameters
- key: K | LikeType<K>
Returns boolean
Overrides OrderedMap.delete
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:80

`Protected` detachInlets

detachInlets(): void
Protected
Returns void
Inherited from WarpDownlink.detachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:803

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.didBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:751

`Protected` `Optional` didClear

didClear(): void
Protected
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:109

`Protected` didClose

didClose(): void
Protected
Returns void
Inherited from WarpDownlink.didClose
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:143

`Protected` didConnect

didConnect(): void
Protected
Returns void
Inherited from WarpDownlink.didConnect
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:139

`Protected` didConsume

didConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.didConsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:198

`Protected` didDisconnect

didDisconnect(): void
Protected
Returns void
Inherited from WarpDownlink.didDisconnect
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:141

`Protected` `Optional` didDrop

didDrop(lower): void
Protected
Parameters
- lower: number
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:101

`Protected` didFail

didFail(error): void
Protected
Parameters
- error: unknown
Returns void
Inherited from WarpDownlink.didFail
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:145

`Protected` didLink

didLink(): void
Protected
Returns void
Inherited from WarpDownlink.didLink
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:129

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from WarpDownlink.didMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:828

`Protected` didObserve

didObserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.didObserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:177

`Protected` `Optional` didRemove

didRemove(key, oldValue): void
Protected
Parameters
- key: K
- oldValue: V
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:97

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from WarpDownlink.didSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:789

`Protected` didSetInherits

didSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from WarpDownlink.didSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:773

`Protected` didStartConsuming

didStartConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.didStartConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:215

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.didStopConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:223

`Protected` didSync

didSync(): void
Protected
Returns void
Inherited from WarpDownlink.didSync
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:133

`Protected` `Optional` didTake

didTake(upper): void
Protected
Parameters
- upper: number
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:105

`Protected` didUnbindInlet

didUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.didUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:760

`Protected` didUnconsume

didUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.didUnconsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:206

`Protected` didUnlink

didUnlink(): void
Protected
Returns void
Inherited from WarpDownlink.didUnlink
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:137

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from WarpDownlink.didUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:836

`Protected` didUnobserve

didUnobserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.didUnobserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:185

`Protected` `Optional` didUpdate

didUpdate(key, newValue, oldValue): void
Protected
Parameters
- key: K
- newValue: V
- oldValue: V
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:93

drop

drop(lower): MapDownlink<R, K, V, I>
Parameters
- lower: number
Returns MapDownlink<R, K, V, I>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:81

entries

entries(): Cursor<[K, V]>
Returns Cursor<[K, V]>
Overrides OrderedMap.entries
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:88

firstEntry

firstEntry(): [K, V]
Returns [K, V]
Overrides OrderedMap.firstEntry
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:69

firstKey

firstKey(): K
Returns K
Overrides OrderedMap.firstKey
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:67

firstValue

firstValue(): V
Returns V
Overrides OrderedMap.firstValue
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:68

forEach

forEach<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((value, key, map) => void | T)
  - - (value, key, map): void | T
    - Parameters
      
      value: V
      
      key: K
      
      map: MapDownlink<any, K, V, [Iterable<[K, V]>]>
      
      Returns void | T
Returns T
Overrides OrderedMap.forEach
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:84
forEach<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, value, key, map) => void | T)
  - - (this, value, key, map): void | T
    - Parameters
      
      this: S
      
      value: V
      
      key: K
      
      map: MapDownlink<any, K, V, [Iterable<[K, V]>]>
      
      Returns void | T
- thisArg: S
Returns T
Overrides OrderedMap.forEach
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:85

get

get(): Iterable<[K, V]>
Returns Iterable<[K, V]>
Overrides WarpDownlink.get
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:64
get(key): V
Parameters
- key: K | LikeType<K>
Returns V
Overrides WarpDownlink.get
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:65

getBody

getBody(): Value
Returns Value
Inherited from WarpDownlink.getBody
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:107

getEntry

getEntry(index): [K, V]
Parameters
- index: number
Returns [K, V]
Overrides OrderedMap.getEntry
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:66

getFastener

getFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from WarpDownlink.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getHostUri

getHostUri(): Uri
Returns Uri
Inherited from WarpDownlink.getHostUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:82

getLaneUri

getLaneUri(): Uri
Returns Uri
Inherited from WarpDownlink.getLaneUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:92

getNodeUri

getNodeUri(): Uri
Returns Uri
Inherited from WarpDownlink.getNodeUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:87

getParentFastener

getParentFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: string
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from WarpDownlink.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:807

getPrio

getPrio(): number
Returns number
Inherited from WarpDownlink.getPrio
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:97

getRate

getRate(): number
Returns number
Inherited from WarpDownlink.getRate
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:102

`Optional` getTransition

getTransition(fastener): Timing
Parameters
- fastener: Fastener<any, any, any>
Returns Timing
Inherited from WarpDownlink.getTransition
- Defined in swim-core/swim-component/dist/swim-component.d.ts:815

has

has(key): boolean
Parameters
- key: K | LikeType<K>
Returns boolean
Overrides OrderedMap.has
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:62

hasAffinity

hasAffinity(affinity): boolean
Parameters
- affinity: Affinity
Returns boolean
Inherited from WarpDownlink.hasAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:778

`Protected` incrementVersion

incrementVersion(): void
Protected
Returns void
Inherited from WarpDownlink.incrementVersion
- Defined in swim-core/swim-component/dist/swim-component.d.ts:737

`Protected` init

init(): void
Protected
Returns void
Inherited from WarpDownlink.init
- Defined in swim-core/swim-component/dist/swim-component.d.ts:725

`Protected` initBody

initBody(): Value
Protected
Returns Value
Inherited from WarpDownlink.initBody
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:105

`Protected` initHostUri

initHostUri(): Uri
Protected
Returns Uri
Inherited from WarpDownlink.initHostUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:80

`Protected` initKeyForm

initKeyForm(): Form<K, LikeType<K>>
Protected
Returns Form<K, LikeType<K>>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:47

`Protected` initLaneUri

initLaneUri(): Uri
Protected
Returns Uri
Inherited from WarpDownlink.initLaneUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:90

`Protected` initNodeUri

initNodeUri(): Uri
Protected
Returns Uri
Inherited from WarpDownlink.initNodeUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:85

`Protected` initPrio

initPrio(): number
Protected
Returns number
Inherited from WarpDownlink.initPrio
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:95

`Protected` initRate

initRate(): number
Protected
Returns number
Inherited from WarpDownlink.initRate
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:100

`Protected` initValueForm

initValueForm(): Form<V, LikeType<V>>
Protected
Returns Form<V, LikeType<V>>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:51

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:61

keys

keys(): Cursor<K>
Returns Cursor<K>
Overrides OrderedMap.keys
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:86

lastEntry

lastEntry(): [K, V]
Returns [K, V]
Overrides OrderedMap.lastEntry
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:72

lastKey

lastKey(): K
Returns K
Overrides OrderedMap.lastKey
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:70

lastValue

lastValue(): V
Returns V
Overrides OrderedMap.lastValue
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:71

nextEntry(keyObject): [K, V]
Parameters
- keyObject: K
Returns [K, V]
Overrides OrderedMap.nextEntry
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:75

nextKey

nextKey(keyObject): K
Parameters
- keyObject: K
Returns K
Overrides OrderedMap.nextKey
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:73

nextValue

nextValue(keyObject): V
Parameters
- keyObject: K
Returns V
Overrides OrderedMap.nextValue
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:74

observe

observe(observer): void
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.observe
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:171

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.onBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:749

`Protected` onCommand

onCommand(body): void
Protected
Parameters
- body: Value
Returns void
Inherited from WarpDownlink.onCommand
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:125

`Protected` onConsume

onConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.onConsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:196

`Protected` onEvent

onEvent(body): void
Protected
Parameters
- body: Value
Returns void
Inherited from WarpDownlink.onEvent
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:123

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from WarpDownlink.onMount
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:232

`Protected` onObserve

onObserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.onObserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:175

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from WarpDownlink.onSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:787

`Protected` onSetInherits

onSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from WarpDownlink.onSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:771

`Protected` onStartConsuming

onStartConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.onStartConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:213

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.onStopConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:221

`Protected` onUnbindInlet

onUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.onUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:758

`Protected` onUnconsume

onUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.onUnconsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:204

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Inherited from WarpDownlink.onUnmount
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:234

`Protected` onUnobserve

onUnobserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.onUnobserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:183

open

open(): MapDownlink<R, K, V, I>
Returns MapDownlink<R, K, V, I>
Overrides WarpDownlink.open
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:133

previousEntry(keyObject): [K, V]
Parameters
- keyObject: K
Returns [K, V]
Overrides OrderedMap.previousEntry
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:78

previousKey

previousKey(keyObject): K
Parameters
- keyObject: K
Returns K
Overrides OrderedMap.previousKey
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:76

previousValue

previousValue(keyObject): V
Parameters
- keyObject: K
Returns V
Overrides OrderedMap.previousValue
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:77

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from WarpDownlink.recohere
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:230

relink

relink(relinks?): MapDownlink<R, K, V, I>
Parameters
- Optional relinks: boolean
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.relink
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:110

requireRecohere

requireRecohere(): void
Returns void
Inherited from WarpDownlink.requireRecohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:795

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from WarpDownlink.requireUpdate
- Defined in swim-core/swim-component/dist/swim-component.d.ts:813

resolveInlets

resolveInlets(): readonly Fastener<any, any, any>[]
Returns readonly Fastener<any, any, any>[]
Inherited from WarpDownlink.resolveInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:799

set

set(key, newValue): MapDownlink<R, K, V, I>
Parameters
- key: K | LikeType<K>
- newValue: V | LikeType<V>
Returns MapDownlink<R, K, V, I>
Overrides OrderedMap.set
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:79

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from WarpDownlink.setAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:783

setBody

setBody(body): MapDownlink<R, K, V, I>
Parameters
- body: ValueLike
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setBody
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:108

`Protected` setCoherent

setCoherent(coherent): void
Protected
Parameters
- coherent: boolean
Returns void
Inherited from WarpDownlink.setCoherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:793

`Protected` setCoherentTime

setCoherentTime(coherentTime): void
Protected
Parameters
- coherentTime: number
Returns void
Inherited from WarpDownlink.setCoherentTime
- Defined in swim-core/swim-component/dist/swim-component.d.ts:734

setHostUri

setHostUri(hostUri): MapDownlink<R, K, V, I>
Parameters
- hostUri: UriLike
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setHostUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:83

setInherits

setInherits(inherits): void
Parameters
- inherits: boolean | PropertyKey
Returns void
Inherited from WarpDownlink.setInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:767

setKeyForm

setKeyForm(keyForm): MapDownlink<R, K, V, I>
Parameters
- keyForm: Form<K, LikeType<K>>
Returns MapDownlink<R, K, V, I>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:49

setLaneUri

setLaneUri(laneUri): MapDownlink<R, K, V, I>
Parameters
- laneUri: UriLike
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setLaneUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:93

setNodeUri

setNodeUri(nodeUri): MapDownlink<R, K, V, I>
Parameters
- nodeUri: UriLike
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setNodeUri
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:88

setPrio

setPrio(prio): MapDownlink<R, K, V, I>
Parameters
- prio: number
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setPrio
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:98

setRate

setRate(rate): MapDownlink<R, K, V, I>
Parameters
- rate: number
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.setRate
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:103

setValueForm

setValueForm(valueForm): MapDownlink<R, K, V, I>
Parameters
- valueForm: Form<V, LikeType<V>>
Returns MapDownlink<R, K, V, I>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:53

snapshot

snapshot(): BTree<Value, Value, never>
Returns BTree<Value, Value, never>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:89

sync

sync(syncs?): MapDownlink<R, K, V, I>
Parameters
- Optional syncs: boolean
Returns MapDownlink<R, K, V, I>
Inherited from WarpDownlink.sync
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:112

take

take(upper): MapDownlink<R, K, V, I>
Parameters
- upper: number
Returns MapDownlink<R, K, V, I>
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:82

toString

toString(): string
Returns string
Inherited from WarpDownlink.toString
- Defined in swim-core/swim-component/dist/swim-component.d.ts:838

unbindInlet

unbindInlet(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.unbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:754

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.unconsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:200

unobserve

unobserve(observer): void
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.unobserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:179

values

values(): Cursor<V>
Returns Cursor<V>
Overrides OrderedMap.values
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:87

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.willBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:747

`Protected` `Optional` willClear

willClear(): void
Protected
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:107

`Protected` willConsume

willConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.willConsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:194

`Protected` `Optional` willDrop

willDrop(lower): void
Protected
Parameters
- lower: number
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:99

`Protected` willLink

willLink(): void
Protected
Returns void
Inherited from WarpDownlink.willLink
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:127

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from WarpDownlink.willMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:824

`Protected` willObserve

willObserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.willObserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:173

`Protected` `Optional` willRemove

willRemove(key): void
Protected
Parameters
- key: K
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:95

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from WarpDownlink.willSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:785

`Protected` willSetInherits

willSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from WarpDownlink.willSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:769

`Protected` willStartConsuming

willStartConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.willStartConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:211

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
Inherited from WarpDownlink.willStopConsuming
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:219

`Protected` willSync

willSync(): void
Protected
Returns void
Inherited from WarpDownlink.willSync
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:131

`Protected` `Optional` willTake

willTake(upper): void
Protected
Parameters
- upper: number
Returns void
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:103

`Protected` willUnbindInlet

willUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from WarpDownlink.willUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:756

`Protected` willUnconsume

willUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from WarpDownlink.willUnconsume
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:202

`Protected` willUnlink

willUnlink(): void
Protected
Returns void
Inherited from WarpDownlink.willUnlink
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:135

`Protected` willUnmount

willUnmount(): void
Protected
Returns void
Inherited from WarpDownlink.willUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:832

`Protected` willUnobserve

willUnobserve(observer): void
Protected
Parameters
- observer: MapDownlinkObserver<K, V, MapDownlink<any, K, V, [Iterable<[K, V]>]>>
Returns void
Inherited from WarpDownlink.willUnobserve
- Defined in swim-host/swim-client/lib/main/WarpDownlink.d.ts:181

`Protected` `Optional` willUpdate

willUpdate(key, newValue): void | V
Protected
Parameters
- key: K
- newValue: V
Returns void | V
- Defined in swim-host/swim-client/lib/main/MapDownlink.d.ts:91

Interface MapDownlink<R, K, V, I>

Type Parameters

R = any

K = Value

V = Value

I extends any[] = [Iterable<[K, V]>]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly [toStringTag]

Readonly body

Readonly coherentTime

Protected Optional Readonly consumed

Readonly hostUri

Readonly inlet

Readonly inletVersion

keyForm

Readonly laneUri

Readonly name

Readonly nodeUri

Optional Readonly observerType

Readonly owner

Readonly prio

Readonly rate

Readonly valueForm

Readonly version

Accessors

affinity

Returns Affinity

authenticated

Returns boolean

binds

Returns boolean

coherent

Returns boolean

connected

Returns boolean

consuming

Returns boolean

deauthenticated

Returns boolean

derived

Returns boolean

descriptorType

Returns Proto<MapDownlinkDescriptor<R, K, V>>

fastenerType

Returns Proto<WarpDownlink<any, any, [any]>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

linked

Returns boolean

mounted

Returns boolean

online

Returns boolean

opened

Returns boolean

parent

Returns Fastener<any, any, any>

parentType

Returns Proto<any>

relinks

Returns boolean

session

Returns Value

size

Returns number

synced

Returns boolean

syncs

Returns boolean

Methods

[iterator]

`Readonly` [toStringTag]

`Readonly` body

`Readonly` coherentTime

`Protected` `Optional` `Readonly` consumed

`Readonly` hostUri

`Readonly` inlet

`Readonly` inletVersion

`Readonly` laneUri

`Readonly` name

`Readonly` nodeUri

`Optional` `Readonly` observerType

`Readonly` owner

`Readonly` prio

`Readonly` rate

`Readonly` valueForm

`Readonly` version

`Protected` attachInlets

this: {
observerType?: Class<R>;
}

`Optional` `Readonly` observerType?: Class<R>

`Rest` ...args: ObserverParameters<R, K>

`Optional` inlet: Fastener<any, any, any>

`Protected` detachInlets

`Protected` didBindInlet

`Protected` `Optional` didClear

`Protected` didClose

`Protected` didConnect

`Protected` didConsume