Class Signals<T, TR>

Signals/Slots, you can associate multiple Slots with Signals, when Signals generate signals, Slots will be called in turn

Type Parameters

T
TR

Hierarchy

Signals

Index

Constructors

Properties

combiner? cons_

Accessors

conns isEmpty length slots value

Methods

connect connectSlot disconnectSlot disconnectTag reset signal

Constructors

constructor

new Signals<T, TR>(combiner?: Combiner<T, TR>): Signals<T, TR>
Type Parameters
- T
- TR
Parameters
- Optional combiner: Combiner<T, TR>
Returns Signals<T, TR>
- Defined in src/signals/signals.ts:37

Properties

`Optional` `Readonly` combiner

combiner?: Combiner<T, TR>

`Private` cons_

cons_: Connection<T, TR>[] = ...

Connected Signals/Slots

Accessors

conns

get conns(): Iterator<Connection<T, TR>, any, undefined>
Returns an iterator to iterate over all connections

Returns Iterator<Connection<T, TR>, any, undefined>
- Defined in src/signals/signals.ts:128

isEmpty

get isEmpty(): boolean
if there is no connections return it rue

Returns boolean
- Defined in src/signals/signals.ts:53

length

get length(): number
Returns the number of connections

Returns number
- Defined in src/signals/signals.ts:47

slots

get slots(): Iterator<Slot<T, TR>, any, undefined>
Returns an iterator to iterate over all slots

Returns Iterator<Slot<T, TR>, any, undefined>
- Defined in src/signals/signals.ts:107

value

get value(): undefined | TR
If there is a combiner, return the latest value of the combiner

Returns undefined | TR
- Defined in src/signals/signals.ts:41

Methods

connect

connect(slot: Slot<T, TR>, tag?: any): Connection<T, TR>
connect Slots to Signals

Returns
Parameters
- slot: Slot<T, TR>
- Optional tag: any
  
  Slots group tag name
Returns Connection<T, TR>
- Defined in src/signals/signals.ts:62

connectSlot

connectSlot(slot: SlotCallback<T, TR>, tag?: any): Connection<T, TR>
connect Signals/Slots

Returns
Parameters
- slot: SlotCallback<T, TR>
- Optional tag: any
  
  Slots group tag name
Returns Connection<T, TR>
- Defined in src/signals/signals.ts:73

disconnectSlot

disconnectSlot(slot: Slot<T, TR>): void
Disconnect all connections from slot to this signals
Parameters
- slot: Slot<T, TR>
Returns void
- Defined in src/signals/signals.ts:150

disconnectTag

disconnectTag(tag: any): void
Disconnect all tags
Parameters
- tag: any
Returns void
- Defined in src/signals/signals.ts:164

reset

reset(): void
delete all slots

Returns void
- Defined in src/signals/signals.ts:189

signal

signal(val: T, combiner?: Combiner<T, TR>): void
Generate a signal to call all Slots
Parameters
- val: T
  
  Parameters passed to the slot
- Optional combiner: Combiner<T, TR>
  
  a temporary combiner
Returns void
- Defined in src/signals/signals.ts:83

Generated using TypeDoc