Class Composite<CompositeEvents>`Abstract`

Base class for chips that contain other chips

Events:

beforeActivatedChildChip(chip: Chip, context: ChipContext, signal: Signal)
activatedChildChip(chip: Chip, context: ChipContext, signal: Signal)
terminatedChildChip(chip: Chip)

Type Parameters

CompositeEvents extends BaseCompositeEvents = BaseCompositeEvents

Hierarchy

ChipBase<CompositeEvents>
- Composite

Constructors

constructor

new Composite<CompositeEvents>(): Composite<CompositeEvents>
Type Parameters
- CompositeEvents extends BaseCompositeEvents<CompositeEvents> = BaseCompositeEvents
Returns Composite<CompositeEvents>

Inherited from ChipBase.constructor

Properties

`Private` _childChipContext

_childChipContext: Record<string, unknown>

`Protected` _childChips

_childChips: Record<string, Chip>

`Protected` _chipContext

_chipContext: Readonly<Record<string, any>>

`Private` _deferredOutputSignal

_deferredOutputSignal: Signal<string>

`Protected` _eventListeners

_eventListeners: IEventListener[] = []

`Protected` `Optional` _inputSignal

_inputSignal?: Signal<string>

`Private` _isReady

_isReady: boolean

`Protected` _lastTickInfo

_lastTickInfo: TickInfo

`Protected` _listeners

_listeners: Listener<CompositeEvents, any>[]

`Private` _methodCallInProgress

_methodCallInProgress: boolean

`Protected` `Optional` _outputSignal

_outputSignal?: Signal<string>

`Protected` `Optional` _preparation

_preparation?: ChipResolvable

`Protected` `Optional` _reloadMemento

_reloadMemento?: ReloadMemento

`Protected` _state

_state: ChipState = "inactive"

Accessors

children

get children(): Record<string, Chip>
Children of this chip, if any

Returns Record<string, Chip>
Overrides ChipBase.children
- Defined in src/chip.ts:644

chipContext

get chipContext(): Readonly<Record<string, any>>
Returns Readonly<Record<string, any>>
Inherited from ChipBase.chipContext
- Defined in src/chip.ts:195

defaultChildChipContext

get defaultChildChipContext(): undefined | ChipContextResolvable
Template getter for the chip context provided to children. Overload to add extra attributes to the context.

Returns undefined | ChipContextResolvable
- Defined in src/chip.ts:840

isReady

get isReady(): boolean
Returns boolean
- Defined in src/chip.ts:543

outputSignal

get outputSignal(): undefined | Signal<string>
Once the chip is terminated, contains the signal

Returns undefined | Signal<string>
Inherited from ChipBase.outputSignal
- Defined in src/chip.ts:400

state

get state(): ChipState
Current state of the chip

Returns ChipState
Inherited from ChipBase.state
- Defined in src/chip.ts:404

Methods

`Protected` _activateChildChip

_activateChildChip(chipResolvable, options?): Chip
Activate a child chip
Parameters
- chipResolvable: ChipResolvable
  
  A chip or function to create a chip
- Optional options: Partial<ActivateChildChipOptions>
Returns Chip
The activated chip
- Defined in src/chip.ts:654

`Protected` _makeReloadMementoData

_makeReloadMementoData(): undefined | ReloadMementoData
By default, a chip be automatically reloaded

Returns undefined | ReloadMementoData
Inherited from ChipBase._makeReloadMementoData
- Defined in src/chip.ts:469

`Protected` _onActivate

_onActivate(): void
Template method called by activate().

Returns void
Inherited from ChipBase._onActivate
- Defined in src/chip.ts:429

`Protected` _onAfterTick

_onAfterTick(): void
Template method called after children are ticked

Returns void
- Defined in src/chip.ts:845

`Protected` _onPause

_onPause(): void
Template method called by pause().

Returns void
Inherited from ChipBase._onPause
- Defined in src/chip.ts:457

`Protected` _onResize

_onResize(width, height): void
Template method called by resize()
Parameters
- width: number
- height: number
Returns void
Inherited from ChipBase._onResize
- Defined in src/chip.ts:443

`Protected` _onResume

_onResume(): void
Template method called by resume().

Returns void
Inherited from ChipBase._onResume
- Defined in src/chip.ts:464

`Protected` _onTerminate

_onTerminate(): void
Template method called by terminate().

Returns void
Inherited from ChipBase._onTerminate
- Defined in src/chip.ts:450

`Protected` _onTick

_onTick(): void
Template method called by tick().

Returns void
Inherited from ChipBase._onTick
- Defined in src/chip.ts:436

`Protected` _removeTerminatedChildChips

_removeTerminatedChildChips(): void
Remove any child chips

Returns void
- Defined in src/chip.ts:825

`Protected` _subscribe

_subscribe<Emitter, EventNames, EventName>(emitter, eventName, cb, subscriptionHandler?): void
Start listening to events of a certain type emitted by an object. The callback will be called with the chip as this. Works by default for both NodeJS- and DOM-style events. If you are interfacing with a different event system, you can provide a subscriptionHandler that knows how to handle it.
Type Parameters
- Emitter extends object
- EventNames extends BaseEventNames
- EventName extends string
Parameters
- emitter: Emitter
- eventName: EventName
- cb: ((this, ...args) => void)
  - - (this, ...args): void
    - Parameters
      
      this: Composite<CompositeEvents>
      
      Rest ...args: EventNames[EventName]
      
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
Inherited from ChipBase._subscribe
- Defined in src/chip.ts:286

`Protected` _subscribeOnce

_subscribeOnce<Emitter, EventNames, EventName>(emitter, eventName, cb, subscriptionHandler?): void
Listen to a single event emitted by an object, then stop. The callback will be called with the chip as this. Works by default for both NodeJS- and DOM-style events. If you are interfacing with a different event system, you can provide a subscriptionHandler that knows how to handle them.
Type Parameters
- Emitter extends object
- EventNames extends BaseEventNames
- EventName extends string
Parameters
- emitter: Emitter
- eventName: EventName
- cb: ((this, ...args) => void)
  - - (this, ...args): void
    - Parameters
      
      this: Composite<CompositeEvents>
      
      Rest ...args: EventNames[EventName]
      
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
Inherited from ChipBase._subscribeOnce
- Defined in src/chip.ts:330

`Protected` _terminateAllChildChips

_terminateAllChildChips(outputSignal?): void
Terminate all the children, with the provided signal
Parameters
- Optional outputSignal: Signal<string>
Returns void
- Defined in src/chip.ts:812

`Protected` _terminateChildChip

_terminateChildChip(chip, outputSignal?): void
Parameters
- chip: Chip
- Optional outputSignal: Signal<string>
Returns void
- Defined in src/chip.ts:778

`Protected` _tickChildChips

_tickChildChips(): void
Check if child chips are still active, and remove them if not Sends tick to all .

Returns void
- Defined in src/chip.ts:803

`Protected` _unsubscribe

_unsubscribe(emitter?, event?, cb?): void
Unsubscribe to a set of events. By default, unsubscribes to everything. If emitter, event, or cb is provided, unsubscribe only to those.
Parameters
- Optional emitter: NodeEventSource
- Optional event: string
- Optional cb: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: unknown[]
      
      Returns void
Returns void
Inherited from ChipBase._unsubscribe
- Defined in src/chip.ts:369

activate

activate(tickInfo, chipContext, inputSignal?, reloadMemento?): void
Activate the chip, with a provided context and input signal. Should only be called from an inactive state
Parameters
- tickInfo: TickInfo
- chipContext: Readonly<Record<string, any>>
- Optional inputSignal: Signal<string>
- Optional reloadMemento: ReloadMemento
Returns void
Overrides ChipBase.activate
- Defined in src/chip.ts:552

emit

emit<Name>(name, ...params): void
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
- Rest ...params: CompositeEvents[Name]
Returns void
Inherited from ChipBase.emit
- Defined in node_modules/@ghom/event-emitter/dist/app/emitter.d.ts:13

makeReloadMemento

makeReloadMemento(): ReloadMemento
Returns ReloadMemento
Inherited from ChipBase.makeReloadMemento
- Defined in src/chip.ts:408

off

off<Name>(name?, run?): void
Type Parameters
- Name extends string | number | symbol
Parameters
- Optional name: Name
- Optional run: ListenerFunction<CompositeEvents, Name>
Returns void
Inherited from ChipBase.off
- Defined in node_modules/@ghom/event-emitter/dist/app/emitter.d.ts:12

on

on<Name>(name, run): void
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
- run: ListenerFunction<CompositeEvents, Name>
Returns void
Inherited from ChipBase.on
- Defined in node_modules/@ghom/event-emitter/dist/app/emitter.d.ts:10

once

once<Name>(name, run): void
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
- run: ListenerFunction<CompositeEvents, Name>
Returns void
Inherited from ChipBase.once
- Defined in node_modules/@ghom/event-emitter/dist/app/emitter.d.ts:11

pause

pause(): void
Pause the chip, informing it that it won't receive ticks for a while

Returns void
Overrides ChipBase.pause
- Defined in src/chip.ts:626

resize

resize(): void
Returns void
Inherited from ChipBase.resize
- Defined in src/chip.ts:236

resume

resume(): void
Resumes the chip after it was paused

Returns void
Overrides ChipBase.resume
- Defined in src/chip.ts:635

terminate

terminate(outputSignal?): void
Terminate the chip. Should only be called from an active or paused state
Parameters
- outputSignal: Signal<string> = ...
Returns void
Overrides ChipBase.terminate
- Defined in src/chip.ts:602

tick

tick(tickInfo): void
By default, updates all child chips and remove those that have a signal Overload this method in subclasses to change the behavior
Parameters
- tickInfo: TickInfo
Returns void
Overrides ChipBase.tick
- Defined in src/chip.ts:583

Class Composite<CompositeEvents>Abstract

Type Parameters

CompositeEvents extends BaseCompositeEvents = BaseCompositeEvents

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

CompositeEvents extends BaseCompositeEvents<CompositeEvents> = BaseCompositeEvents

Returns Composite<CompositeEvents>

Properties

Private _childChipContext

Protected _childChips

Protected _chipContext

Private _deferredOutputSignal

Protected _eventListeners

Protected Optional _inputSignal

Private _isReady

Protected _lastTickInfo

Protected _listeners

Private _methodCallInProgress

Protected Optional _outputSignal

Protected Optional _preparation

Protected Optional _reloadMemento

Protected _state

Accessors

children

Returns Record<string, Chip>

chipContext

Returns Readonly<Record<string, any>>

defaultChildChipContext

Returns undefined | ChipContextResolvable

isReady

Returns boolean

outputSignal

Returns undefined | Signal<string>

state

Returns ChipState

Methods

Protected _activateChildChip

Parameters

chipResolvable: ChipResolvable

Optional options: Partial<ActivateChildChipOptions>

Returns Chip

Protected _makeReloadMementoData

Returns undefined | ReloadMementoData

Protected _onActivate

Returns void

Protected _onAfterTick

Returns void

Protected _onPause

Returns void

Protected _onResize

Parameters

width: number

height: number

Returns void

Protected _onResume

Returns void

Protected _onTerminate

Returns void

Protected _onTick

Returns void

Protected _removeTerminatedChildChips

Returns void

Protected _subscribe

Type Parameters

Emitter extends object

EventNames extends BaseEventNames

EventName extends string

Parameters

emitter: Emitter

eventName: EventName

cb: ((this, ...args) => void)

Parameters

this: Composite<CompositeEvents>

Class Composite<CompositeEvents>`Abstract`

`Private` _childChipContext

`Protected` _childChips

`Protected` _chipContext

`Private` _deferredOutputSignal

`Protected` _eventListeners

`Protected` `Optional` _inputSignal

`Private` _isReady

`Protected` _lastTickInfo

`Protected` _listeners

`Private` _methodCallInProgress

`Protected` `Optional` _outputSignal

`Protected` `Optional` _preparation

`Protected` `Optional` _reloadMemento

`Protected` _state

`Protected` _activateChildChip

`Optional` options: Partial<ActivateChildChipOptions>

`Protected` _makeReloadMementoData

`Protected` _onActivate

`Protected` _onAfterTick

`Protected` _onPause

`Protected` _onResize

`Protected` _onResume

`Protected` _onTerminate

`Protected` _onTick

`Protected` _removeTerminatedChildChips

`Protected` _subscribe

`Rest` ...args: EventNames[EventName]

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _subscribeOnce

`Rest` ...args: EventNames[EventName]

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _terminateAllChildChips

`Optional` outputSignal: Signal<string>

`Protected` _terminateChildChip

`Optional` outputSignal: Signal<string>

`Protected` _tickChildChips

`Protected` _unsubscribe

`Optional` emitter: NodeEventSource

`Optional` event: string

`Optional` cb: ((...args) => void)

`Rest` ...args: unknown[]

`Optional` inputSignal: Signal<string>

`Optional` reloadMemento: ReloadMemento

`Rest` ...params: CompositeEvents[Name]

`Optional` name: Name

`Optional` run: ListenerFunction<CompositeEvents, Name>