Class WaitForEvent<Emitter, EventNames, EventName>

Waits for an event to be delivered, and decides to request a signal depending on the event value.

Handler

is a function of the event arguments, and should return either a signal or a boolean as to whether to signal or not

Type Parameters

Emitter extends object
EventNames extends Emitter extends ChipBase<infer _EventNames>
? _EventNames
: BaseEventNames
EventName extends keyof EventNames & string

Hierarchy

ChipBase
- WaitForEvent

Index

Constructors

constructor

new WaitForEvent<Emitter, EventNames, EventName>(emitter, eventName, handler?): WaitForEvent<Emitter, EventNames, EventName>
Type Parameters
- Emitter extends object
- EventNames extends BaseEventNames
- EventName extends string
Parameters
- emitter: Emitter
- eventName: EventName
- handler: ((...args) => boolean | Signal<string>) = ...
  - - (...args): boolean | Signal<string>
    - Parameters
      
      Rest ...args: EventNames[EventName]
      
      Returns boolean | Signal<string>
Returns WaitForEvent<Emitter, EventNames, EventName>
Overrides ChipBase.constructor
- Defined in src/chip.ts:1507

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<BaseChipBaseEvents, any>[]

`Protected` `Optional` _outputSignal

_outputSignal?: Signal<string>

`Protected` `Optional` _reloadMemento

_reloadMemento?: ReloadMemento

`Protected` _state

_state: ChipState = "inactive"

emitter

emitter: Emitter

eventName

eventName: EventName

handler

handler: ((...args) => boolean | Signal<string>) = ...

Type declaration

- (...args): boolean | Signal<string>
- Parameters
  - Rest ...args: EventNames[EventName]
  Returns boolean | Signal<string>

Accessors

children

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

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

chipContext

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

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

_handleEvent

_handleEvent(...args): void
Parameters
- Rest ...args: EventNames[EventName]
Returns void
- Defined in src/chip.ts:1520

`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

_onActivate

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

Returns void
Overrides ChipBase._onActivate
- Defined in src/chip.ts:1516

`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` _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: WaitForEvent<Emitter, EventNames, EventName>
      
      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: WaitForEvent<Emitter, EventNames, EventName>
      
      Rest ...args: EventNames[EventName]
      
      Returns void
- Optional subscriptionHandler: SubscriptionHandler
Returns void
Inherited from ChipBase._subscribeOnce
- 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
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
Inherited from ChipBase.activate
- Defined in src/chip.ts:199

emit

emit<Name>(name, ...params): void
Type Parameters
- Name extends keyof BaseChipBaseEvents
Parameters
- name: Name
- Rest ...params: BaseChipBaseEvents[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 keyof BaseChipBaseEvents
Parameters
- Optional name: Name
- Optional run: ListenerFunction<BaseChipBaseEvents, 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 keyof BaseChipBaseEvents
Parameters
- name: Name
- run: ListenerFunction<BaseChipBaseEvents, 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 keyof BaseChipBaseEvents
Parameters
- name: Name
- run: ListenerFunction<BaseChipBaseEvents, 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
Inherited from ChipBase.pause
- Defined in src/chip.ts:261

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
Inherited from ChipBase.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
Inherited from ChipBase.terminate
- Defined in src/chip.ts:247

tick

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

Class WaitForEvent<Emitter, EventNames, EventName>

Handler

Type Parameters

Emitter extends object

EventNames extends Emitter extends ChipBase<infer _EventNames> ? _EventNames : BaseEventNames

EventName extends keyof EventNames & string

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Emitter extends object

EventNames extends BaseEventNames

EventName extends string

Parameters

emitter: Emitter

eventName: EventName

handler: ((...args) => boolean | Signal<string>) = ...

Parameters

Rest ...args: EventNames[EventName]

Returns boolean | Signal<string>

Returns WaitForEvent<Emitter, EventNames, EventName>

Properties

Protected _chipContext

Protected _eventListeners

Protected Optional _inputSignal

Protected _lastTickInfo

Protected _listeners

Protected Optional _outputSignal

Protected Optional _reloadMemento

Protected _state

emitter

eventName

handler

Type declaration

Parameters

Rest ...args: EventNames[EventName]

Returns boolean | Signal<string>

Accessors

children

Returns Record<string, Chip>

chipContext

Returns Readonly<Record<string, any>>

outputSignal

Returns undefined | Signal<string>

state

Returns ChipState

Methods

_handleEvent

Parameters

Rest ...args: EventNames[EventName]

Returns void

Protected _makeReloadMementoData

Returns undefined | ReloadMementoData

_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

EventNames extends Emitter extends ChipBase<infer _EventNames>
? _EventNames
: BaseEventNames

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

`Protected` _chipContext

`Protected` _eventListeners

`Protected` `Optional` _inputSignal

`Protected` _lastTickInfo

`Protected` _listeners

`Protected` `Optional` _outputSignal

`Protected` `Optional` _reloadMemento

`Protected` _state

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

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

`Protected` _makeReloadMementoData

`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: BaseChipBaseEvents[Name]

`Optional` name: Name

`Optional` run: ListenerFunction<BaseChipBaseEvents, Name>