Class ComponentAbstract<EventTypes>`Abstract`

Type Parameters

EventTypes extends string = string

Hierarchy

EventEmitter<EventTypes>
- ComponentAbstract
  - ObnizBLE
  - Display
  - Location
  - Motion
  - Storage
  - ObnizSwitch
  - PeripheralAD
  - PeripheralCANBus
  - Directive
  - PeripheralGrove
  - PeripheralI2C
  - PeripheralIO
  - PeripheralPWM
  - PeripheralSPI
  - PeripheralUART
  - LogicAnalyzer
  - ObnizMeasure
  - Tcp

Index

Constructors

Properties

Obniz timeout prefixed

Methods

addListener emit eventNames fastValidate listenerCount listeners notifyFromObniz off on once removeAllListeners removeListener schemaBasePath validate

Constructors

constructor

new ComponentAbstract<EventTypes>(obniz): ComponentAbstract<EventTypes>
Type Parameters
- EventTypes extends string = string
Parameters
- obniz: Obniz
Returns ComponentAbstract<EventTypes>
Overrides EventEmitter<EventTypes>.constructor
- Defined in src/obniz/libs/ComponentAbstact.ts:48

Properties

Obniz

Obniz: Obniz

obniz to be used

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event, fn, context?): ComponentAbstract<EventTypes>
Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

emit

emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: EventTypes
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:27

eventNames

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

Returns EventTypes[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

fastValidate

fastValidate(commandUri, json): boolean
Parameters
- commandUri: any
- json: any
Returns boolean
- Defined in src/obniz/libs/ComponentAbstact.ts:91

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: EventTypes
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22

listeners

listeners(event): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: EventTypes
Returns ListenerFn[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

notifyFromObniz

notifyFromObniz(json): void
Parameters
- json: any
Returns void
- Defined in src/obniz/libs/ComponentAbstact.ts:53

off

off(event, fn?, context?, once?): ComponentAbstract<EventTypes>
Parameters
- event: EventTypes
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event, fn, context?): ComponentAbstract<EventTypes>
Add a listener for a given event.
Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event, fn, context?): ComponentAbstract<EventTypes>
Add a one-time listener for a given event.
Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?): ComponentAbstract<EventTypes>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: EventTypes
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event, fn?, context?, once?): ComponentAbstract<EventTypes>
Remove the listeners of a given event.
Parameters
- event: EventTypes
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns ComponentAbstract<EventTypes>
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

`Abstract` schemaBasePath

schemaBasePath(): null | string
Returns null | string
- Defined in src/obniz/libs/ComponentAbstact.ts:96

validate

validate(commandUri, json): MultiResult
Parameters
- commandUri: any
- json: any
Returns MultiResult
- Defined in src/obniz/libs/ComponentAbstact.ts:86

Generated using TypeDoc