Class ContextProvider

Base class for chips that contain other chips

Events:

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

Hierarchy (view full)

Composite
- ContextProvider

Constructors

constructor

new ContextProvider(_context, _child): ContextProvider
Parameters
- _context: Record<string, ChipResolvable>
- _child: ChipResolvable
Returns ContextProvider
Overrides Composite.constructor
- Defined in src/chip.ts:989

Properties

`Private` `Readonly` _child

_child: ChipResolvable

`Protected` _childChips

_childChips: Record<string, Chip>

`Protected` _chipContext

_chipContext: Readonly<Record<string, any>>

`Private` `Readonly` _context

_context: Record<string, ChipResolvable>

`Protected` _eventListeners

_eventListeners: IEventListener[] = []

`Protected` _inputSignal

_inputSignal: Signal

`Protected` _lastTickInfo

_lastTickInfo: TickInfo

`Protected` _outputSignal

_outputSignal: Signal

`Protected` `Optional` _reloadMemento

_reloadMemento?: ReloadMemento

`Protected` _state

_state: ChipState = "inactive"

`Static` prefixed

prefixed: string | boolean

Accessors

children

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

Returns Record<string, Chip>
Inherited from Composite.children
- Defined in src/chip.ts:642

chipContext

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

defaultChildChipContext

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

Returns ChipContextResolvable
Inherited from Composite.defaultChildChipContext
- Defined in src/chip.ts:858

outputSignal

get outputSignal(): Signal
Once the chip is terminated, contains the signal

Returns Signal
Inherited from Composite.outputSignal
- Defined in src/chip.ts:447

state

get state(): ChipState
Current state of the chip

Returns ChipState
Inherited from Composite.state
- Defined in src/chip.ts:451

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
Inherited from Composite._activateChildChip
- Defined in src/chip.ts:652
_activateChildChip(options): Chip
Activate a child chip
Parameters
- options: Partial<ChipActivationInfo> & {
  chip: ChipResolvable;
  }
  The chip and its options
Returns Chip
The activated chip
Inherited from Composite._activateChildChip
- Defined in src/chip.ts:661

`Protected` _getChildChipId

_getChildChipId(chip): string
Returns the ID of the child chip, or undefined if the chip is not an active child
Parameters
- chip: Chip
Returns string
Inherited from Composite._getChildChipId
- Defined in src/chip.ts:840

`Protected` _makeReloadMementoData

_makeReloadMementoData(): ReloadMementoData
By default, an chip be automatically reloaded

Returns ReloadMementoData
Inherited from Composite._makeReloadMementoData
- Defined in src/chip.ts:507

`Protected` _onActivate

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

Returns void
Overrides Composite._onActivate
- Defined in src/chip.ts:996

`Protected` _onAfterTick

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

Returns void
Inherited from Composite._onAfterTick
- Defined in src/chip.ts:863

`Protected` _onPause

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

Returns void
Inherited from Composite._onPause
- Defined in src/chip.ts:495

`Protected` _onResume

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

Returns void
Inherited from Composite._onResume
- Defined in src/chip.ts:502

`Protected` _onTerminate

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

Returns void
Inherited from Composite._onTerminate
- Defined in src/chip.ts:488

`Protected` _onTick

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

Returns void
Inherited from Composite._onTick
- Defined in src/chip.ts:481

`Protected` _subscribe

_subscribe(emitter, event, 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.
Parameters
- emitter: object
- event: string
- cb: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
Inherited from Composite._subscribe
- Defined in src/chip.ts:340

`Protected` _subscribeOnce

_subscribeOnce(emitter, event, 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.
Parameters
- emitter: object
- event: string
- cb: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
Inherited from Composite._subscribeOnce
- Defined in src/chip.ts:379

`Protected` _terminateAllChildChips

_terminateAllChildChips(outputSignal?): void
Terminate all the children, with the provided signal
Parameters
- Optional outputSignal: Signal
Returns void
Inherited from Composite._terminateAllChildChips
- Defined in src/chip.ts:831

`Protected` _terminateChildChip

_terminateChildChip(chip, outputSignal?): void
An alias for calling terminate() on the child chip
Parameters
- chip: Chip
- Optional outputSignal: Signal
Returns void
Inherited from Composite._terminateChildChip
- Defined in src/chip.ts:812

`Protected` _tickChildChips

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

Returns void
Inherited from Composite._tickChildChips
- Defined in src/chip.ts:824

`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: object
- Optional event: string
- Optional cb: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: unknown[]
      Returns void
Returns void
Inherited from Composite._unsubscribe
- Defined in src/chip.ts:414

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>>
- inputSignal: Signal
- Optional reloadMemento: ReloadMemento
Returns void
Inherited from Composite.activate
- Defined in src/chip.ts:565

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from Composite.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from Composite.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from Composite.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

hasChildChip

hasChildChip(chip): boolean
Parameters
- chip: Chip
Returns boolean
Inherited from Composite.hasChildChip
- Defined in src/chip.ts:850

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from Composite.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from Composite.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

makeReloadMemento

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

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from Composite.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from Composite.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from Composite.once
- Defined in node_modules/eventemitter3/index.d.ts:54

pause

pause(tickInfo): void
Pause the chip, informing it that it won't receive ticks for a while
Parameters
- tickInfo: TickInfo
Returns void
Inherited from Composite.pause
- Defined in src/chip.ts:626

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns this
Inherited from Composite.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from Composite.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resume

resume(tickInfo): void
Resumes the chip after it was paused
Parameters
- tickInfo: TickInfo
Returns void
Inherited from Composite.resume
- Defined in src/chip.ts:634

terminate

terminate(outputSignal?): void
Terminate the chip. Should only be called from an active or paused state
Parameters
- outputSignal: Signal = ...
Returns void
Inherited from Composite.terminate
- Defined in src/chip.ts:603

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
Inherited from Composite.tick
- Defined in src/chip.ts:583

Class ContextProvider

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_context: Record<string, ChipResolvable>

_child: ChipResolvable

Returns ContextProvider

Properties

Private Readonly _child

Protected _childChips

Protected _chipContext

Private Readonly _context

Protected _eventListeners

Protected _inputSignal

Protected _lastTickInfo

Protected _outputSignal

Protected Optional _reloadMemento

Protected _state

Static prefixed

Accessors

children

Returns Record<string, Chip>

chipContext

Returns Readonly<Record<string, any>>

defaultChildChipContext

Returns ChipContextResolvable

outputSignal

Returns Signal

state

Returns ChipState

Methods

Protected _activateChildChip

Parameters

chipResolvable: ChipResolvable

Optional options: Partial<ActivateChildChipOptions>

Returns Chip

Parameters

options: Partial<ChipActivationInfo> & { chip: ChipResolvable; }

Returns Chip

Protected _getChildChipId

Parameters

chip: Chip

Returns string

Protected _makeReloadMementoData

Returns ReloadMementoData

Protected _onActivate

Returns void

Protected _onAfterTick

Returns void

Protected _onPause

Returns void

Protected _onResume

Returns void

Protected _onTerminate

Returns void

Protected _onTick

Returns void

Protected _subscribe

Parameters

emitter: object

event: string

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

Parameters

Rest ...args: any[]

Returns void

Optional subscriptionHandler: SubscriptionHandler

Returns void

Protected _subscribeOnce

Parameters

emitter: object

event: string

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

Parameters

Rest ...args: any[]

`Private` `Readonly` _child

`Protected` _childChips

`Protected` _chipContext

`Private` `Readonly` _context

`Protected` _eventListeners

`Protected` _inputSignal

`Protected` _lastTickInfo

`Protected` _outputSignal

`Protected` `Optional` _reloadMemento

`Protected` _state

`Static` prefixed

`Protected` _activateChildChip

`Optional` options: Partial<ActivateChildChipOptions>

options: Partial<ChipActivationInfo> & {
chip: ChipResolvable;
}

`Protected` _getChildChipId

`Protected` _makeReloadMementoData

`Protected` _onActivate

`Protected` _onAfterTick

`Protected` _onPause

`Protected` _onResume

`Protected` _onTerminate

`Protected` _onTick

`Protected` _subscribe

`Rest` ...args: any[]

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _subscribeOnce

`Rest` ...args: any[]

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _terminateAllChildChips

`Optional` outputSignal: Signal

`Protected` _terminateChildChip

`Optional` outputSignal: Signal

`Protected` _tickChildChips

`Protected` _unsubscribe

`Optional` emitter: object

`Optional` event: string

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

`Rest` ...args: unknown[]

`Optional` reloadMemento: ReloadMemento

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]