Class ChipBase<ChipBaseEvents>`Abstract`

A base class for creating chips that reduces boilerplate code. To use it, simply override some or all of the following protected methods:

_onActivate()
_onTick()
_onTerminate()
_onPause()
_onResume() In these methods, you can access the _chipContext _lastTickInfo properties to obtain the latest information there.

In addition, you can subscribe to events using _subscribe() in a way that automatically unsubscribes when the chip is terminated.

Index

Constructors

constructor

Properties

_chipContext _eventListeners _inputSignal? _lastTickInfo _listeners _outputSignal? _reloadMemento? _state

Accessors

children chipContext outputSignal state

Constructors

constructor

new ChipBase<ChipBaseEvents>(): ChipBase<ChipBaseEvents>
Type Parameters
- ChipBaseEvents extends BaseChipBaseEvents<ChipBaseEvents> = BaseChipBaseEvents
Returns ChipBase<ChipBaseEvents>

Inherited from EventEmitter<ChipBaseEvents>.constructor

Properties

`Protected` _chipContext

_chipContext: Readonly<Record<string, any>>

`Protected` _eventListeners

_eventListeners: IEventListener[] = []

`Protected` `Optional` _inputSignal

_inputSignal?: Signal<string>

`Protected` _lastTickInfo

_lastTickInfo: TickInfo

`Protected` _listeners

_listeners: Listener<ChipBaseEvents, any>[]

`Protected` `Optional` _outputSignal

_outputSignal?: Signal<string>

`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>
Implementation of Chip.children
- Defined in src/chip.ts:396

chipContext

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

outputSignal

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

Returns undefined | Signal<string>
Implementation of Chip.outputSignal
- Defined in src/chip.ts:400

state

get state(): ChipState
Current state of the chip

Returns ChipState
Implementation of Chip.state
- Defined in src/chip.ts:404

Methods

`Protected` _makeReloadMementoData

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

Returns undefined | ReloadMementoData
- Defined in src/chip.ts:469

`Protected` _onActivate

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

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

`Protected` _onPause

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

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

`Protected` _onResize

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

`Protected` _onResume

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

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

`Protected` _onTerminate

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

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

`Protected` _onTick

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

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

`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: ChipBase<ChipBaseEvents>
      
      Rest ...args: EventNames[EventName]
      
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
- 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: ChipBase<ChipBaseEvents>
      
      Rest ...args: EventNames[EventName]
      
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
- Defined in src/chip.ts:330

`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
- 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
Implementation of Chip.activate
- Defined in src/chip.ts:199

emit

emit<Name>(name, ...params): void
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
- Rest ...params: ChipBaseEvents[Name]
Returns void
Implementation of Chip.emit

Inherited from EventEmitter.emit
- Defined in node_modules/@ghom/event-emitter/dist/app/emitter.d.ts:13

makeReloadMemento

makeReloadMemento(): ReloadMemento
Returns ReloadMemento
Implementation of Chip.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<ChipBaseEvents, Name>
Returns void
Implementation of Chip.off

Inherited from EventEmitter.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<ChipBaseEvents, Name>
Returns void
Implementation of Chip.on

Inherited from EventEmitter.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<ChipBaseEvents, Name>
Returns void
Implementation of Chip.once

Inherited from EventEmitter.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
Implementation of Chip.pause
- Defined in src/chip.ts:261

resize

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

resume

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

Returns void
Implementation of Chip.resume
- Defined in src/chip.ts:270

terminate

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

tick

tick(tickInfo): void
Update the chip, provided a new time
Parameters
- tickInfo: TickInfo
Returns void
Implementation of Chip.tick
- Defined in src/chip.ts:227

Class ChipBase<ChipBaseEvents>Abstract

Type Parameters

ChipBaseEvents extends BaseChipBaseEvents = BaseChipBaseEvents

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

ChipBaseEvents extends BaseChipBaseEvents<ChipBaseEvents> = BaseChipBaseEvents

Returns ChipBase<ChipBaseEvents>

Properties

Protected _chipContext

Protected _eventListeners

Protected Optional _inputSignal

Protected _lastTickInfo

Protected _listeners

Protected Optional _outputSignal

Protected Optional _reloadMemento

Protected _state

Accessors

children

Returns Record<string, Chip>

chipContext

Returns Readonly<Record<string, any>>

outputSignal

Returns undefined | Signal<string>

state

Returns ChipState

Methods

Protected _makeReloadMementoData

Returns undefined | ReloadMementoData

Protected _onActivate

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 _subscribe

Type Parameters

Emitter extends object

EventNames extends BaseEventNames

EventName extends string

Parameters

emitter: Emitter

eventName: EventName

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

Parameters

this: ChipBase<ChipBaseEvents>

Rest ...args: EventNames[EventName]

Returns void

Optional subscriptionHandler: SubscriptionHandler

Returns void

Protected _subscribeOnce

Type Parameters

Emitter extends object

EventNames extends BaseEventNames

EventName extends string

Parameters

emitter: Emitter

eventName: EventName

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

Parameters

this: ChipBase<ChipBaseEvents>

Rest ...args: EventNames[EventName]

Returns void

Optional subscriptionHandler: SubscriptionHandler

Class ChipBase<ChipBaseEvents>`Abstract`

`Protected` _chipContext

`Protected` _eventListeners

`Protected` `Optional` _inputSignal

`Protected` _lastTickInfo

`Protected` _listeners

`Protected` `Optional` _outputSignal

`Protected` `Optional` _reloadMemento

`Protected` _state

`Protected` _makeReloadMementoData

`Protected` _onActivate

`Protected` _onPause

`Protected` _onResize

`Protected` _onResume

`Protected` _onTerminate

`Protected` _onTick

`Protected` _subscribe

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

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _subscribeOnce

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

`Optional` subscriptionHandler: SubscriptionHandler

`Protected` _unsubscribe

`Optional` emitter: NodeEventSource

`Optional` event: string

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

`Rest` ...args: unknown[]

`Optional` inputSignal: Signal<string>

`Optional` reloadMemento: ReloadMemento

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

`Optional` name: Name

`Optional` run: ListenerFunction<ChipBaseEvents, Name>