Class NaiveGridSignal

Hierarchy

BaseSignal<GridSignalConfigs>
- NaiveGridSignal

Index

Constructors

constructor

Events

on

Properties

Methods

Constructors

constructor

new NaiveGridSignal(config: GridSignalConfigs, logger: Logger): NaiveGridSignal

Overrides BaseSignal<GridSignalConfigs>.constructor
- Defined in signal/naive-grid-signal/naive-grid-signal.ts:29
Parameters
- config: GridSignalConfigs
- logger: Logger
Returns NaiveGridSignal

Events

on

on<E>(event: E, listener: SignalEventListener<E>): void

Inherited from BaseSignal.on
- Defined in signal/base-signal.ts:31
Type parameters
- E: keyof SignalEventMap
Parameters
- event: E
- listener: SignalEventListener<E>
Returns void

Properties

config

config: GridSignalConfigs

eventEmitter

eventEmitter: EventEmitter = ...

hasStarted

hasStarted: boolean = false

interval

interval: number

isPaused

isPaused: boolean = false

isRunning

isRunning: boolean = false

logger

logger: Logger

Methods

emit

emit<E>(event: E, payload: SignalEventPayload<E>): void

Inherited from BaseSignal.emit
- Defined in signal/base-signal.ts:43
Type parameters
- E: keyof SignalEventMap
Parameters
- event: E
- payload: SignalEventPayload<E>
Returns void

off

off<E>(event: E, listener: SignalEventListener<E>): void

Inherited from BaseSignal.off
- Defined in signal/base-signal.ts:35
Type parameters
- E: keyof SignalEventMap
Parameters
- event: E
- listener: SignalEventListener<E>
Returns void

once

once<E>(event: E, listener: SignalEventListener<E>): void

Inherited from BaseSignal.once
- Defined in signal/base-signal.ts:39
Type parameters
- E: keyof SignalEventMap
Parameters
- event: E
- listener: SignalEventListener<E>
Returns void

pause

pause(): Promise<boolean>

Inherited from BaseSignal.pause
- Defined in signal/base-signal.ts:63
Returns Promise<boolean>

resume

resume(): Promise<boolean>

Inherited from BaseSignal.resume
- Defined in signal/base-signal.ts:71
Returns Promise<boolean>

run

run(): Promise<void>

Inherited from BaseSignal.run
- Defined in signal/base-signal.ts:79
Returns Promise<void>

start

start(): Promise<boolean>

Inherited from BaseSignal.start
- Defined in signal/base-signal.ts:47
Returns Promise<boolean>

stop

stop(): Promise<boolean>

Inherited from BaseSignal.stop
- Defined in signal/base-signal.ts:55
Returns Promise<boolean>

tick

tick(): Promise<void>

Overrides BaseSignal.tick
- Defined in signal/naive-grid-signal/naive-grid-signal.ts:33
Returns Promise<void>

Generated using TypeDoc