MapOutlet | swimOS

Output connector from a Streamlet for a key-value map state.

Type parameters

Hierarchy

Outlet<O>
- MapOutlet

Index

Methods

bindOutput

bindOutput(output: Inlet<O>): void

Inherited from Inoutlet.bindOutput
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:55
Adds an output to the set of Inlets that depend on the state of this Outlet. The output will be invalidated when the state of this Outlet is invalidated, and updated when this Outlet is updated.

Parameters
- output: Inlet<O>
Returns void

disconnectInputs

disconnectInputs(): void

Inherited from Outlet.disconnectInputs
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:82
Disconnects all Inlets dominated by this Outlet in the dataflow dependency graph. Used to recursively clean up chains of combinators passing through this Outlet.

Returns void

disconnectOutputs

disconnectOutputs(): void

Inherited from Outlet.disconnectOutputs
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:75
Disconnects all Outlets dominated by this Outlet in the dataflow graph. Used to recursively clean up chains of combinators originating from this Inlet.

Returns void

filter

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

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:79
Parameters
- func: FilterFieldsFunction<K, V>
Returns MapOutlet<K, V, Map<K, V>>

get

get(): O | undefined
get(key: K): V | undefined

Overrides Inoutlet.get
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:40
Returns the current state of this Outlet.

Returns O | undefined
Overrides Inoutlet.get
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:46
Returns the value assocaited with the given key in the current state of this MapOutlet, if defined; otherwise returns undefined.

Parameters
- key: K
Returns V | undefined

has

has(key: K): boolean

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:35
Returns true if the current state of this MapOutlet contains the given key; otherwise returns false.

Parameters
- key: K
Returns boolean

invalidateInput

invalidateInput(): void

Inherited from Inoutlet.invalidateInput
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:88
Marks this Outlet—and all outputs that depend on the state of this Outlet—as having stale state.

Returns void

invalidateInputKey

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

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:64
Marks this MapOutlet as needing an effect applied to a given key. Invalidating an individual key invalidates the entire state of the Outlet. But only the invalidated keys need to be updated in order to reconcile the overall state of the Outlet.

Parameters
- key: K
- effect: KeyEffect
Returns void

keyIterator

keyIterator(): Iterator<K>

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:51
Returns an Iterator over the keys in the current state of this MapOutlet.

Returns Iterator<K>

map

map<O2>(func: MapValueFunction<O, O2>): Outlet<O2>
map<V2>(func: MapFieldValuesFunction<K, V, V2>): MapOutlet<K, V2, Map<K, V2>>

Overrides Inoutlet.map
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:81
Type parameters
- O2
Parameters
- func: MapValueFunction<O, O2>
Returns Outlet<O2>
Overrides Inoutlet.map
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:82
Type parameters
- V2
Parameters
- func: MapFieldValuesFunction<K, V, V2>
Returns MapOutlet<K, V2, Map<K, V2>>

memoize

memoize(): MapOutlet<K, V, O>

Overrides Inoutlet.memoize
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:77
Returns MapOutlet<K, V, O>

outlet

outlet(key: K): Outlet<V>

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:56
Returns an Outlet that updates when the specified key updates.

Parameters
- key: K
Returns Outlet<V>

outputIterator

outputIterator(): Iterator<Inlet<O>>

Inherited from Inoutlet.outputIterator
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:48
Returns an Iterator over the set of Inlets that depend on the state of this Outlet.

Returns Iterator<Inlet<O>>

reconcileInput

reconcileInput(version: number): void

Inherited from Inoutlet.reconcileInput
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:97
Reconciles the state of this Outlet, if the version of this Outlet's state differs from the target version. To reconcile its state, the Outlet first invokes Streamlet.reconcile on the Streamlet to which it's attached. It then invokes Inlet.reconcileOutput on each of its dependent outputs.

Parameters
- version: number
Returns void

reconcileInputKey

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

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:75
Reconciles the state of an individual key in this MapOutlet, if the version of this MapOutlet's state differs from the target version. To reconcile the state of a key, the MapOutlet first invokes Streamlet.reconcile on its attached streamlets. Then, for each dependent output, it invokes MapInlet.reconcileOutputKey, if the dependent output is a MapInlet, or it invokes [[Inlet.reconcile]], if the dependent output is not a MapInlet.

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>

- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:84
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>

unbindOutput

unbindOutput(output: Inlet<O>): void

Inherited from Inoutlet.unbindOutput
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:61
Removes an output from the set of Inlets that depend on the state of this Outlet.

Parameters
- output: Inlet<O>
Returns void

unbindOutputs

unbindOutputs(): void

Inherited from Inoutlet.unbindOutputs
- Defined in swim-core-js/@swim/streamlet/main/Outlet.ts:68
Disconnects all outputs from this Outlet by invoking Inlet.unbindInput on each Inelt that depends on the state of this Outlet.

Returns void

watch

watch(func: WatchValueFunction<O>): this
watch(func: WatchFieldsFunction<K, V>): this

Overrides Inoutlet.watch
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:86
Parameters
- func: WatchValueFunction<O>
Returns this
Overrides Inoutlet.watch
- Defined in swim-core-js/@swim/streamlet/main/MapOutlet.ts:87
Parameters
- func: WatchFieldsFunction<K, V>
Returns this

Type parameters

K

V

O

Hierarchy

Index

Methods

Methods

bindOutput

Parameters

output: Inlet<O>

Returns void

disconnectInputs

Returns void

disconnectOutputs

Returns void

filter

Parameters

func: FilterFieldsFunction<K, V>

Returns MapOutlet<K, V, Map<K, V>>

get

Returns O | undefined

Parameters

key: K

Returns V | undefined

has

Parameters

key: K

Returns boolean

invalidateInput

Returns void

invalidateInputKey

Parameters

key: K

effect: KeyEffect

Returns void

keyIterator

Returns Iterator<K>

map

Type parameters

O2

Parameters

func: MapValueFunction<O, O2>

Returns Outlet<O2>

Type parameters

V2

Parameters

func: MapFieldValuesFunction<K, V, V2>

Returns MapOutlet<K, V2, Map<K, V2>>

memoize

Returns MapOutlet<K, V, O>

outlet

Parameters

key: K

Returns Outlet<V>

outputIterator

Returns Iterator<Inlet<O>>

reconcileInput

Parameters

version: number

Returns void

reconcileInputKey

Parameters

key: K

version: number

Returns void

reduce

Type parameters

U

Parameters

identity: U

accumulator: (result: U, element: V) => U

Parameters

result: U

element: V

Returns U

combiner: (result: U, result2: U) => U

Parameters

result: U

result2: U