Class BDAbstractProperty<Tag, Type, Data>`Abstract`

Abstract base class for all types of properties.

Type Parameters

Tag extends ApplicationTag
Type extends ApplicationTagValueTypeMap[Tag]
Data extends BACNetAppData<Tag, Type> | BACNetAppData<Tag, Type>[]

Hierarchy (View Summary)

AsyncEventEmitter<BDPropertyEvents<Tag, Type, Data>>
- BDAbstractProperty

Index

Constructors

Properties

identifier type

Methods

addListener getData on setData

Constructors

constructor

new BDAbstractProperty<
    Tag extends ApplicationTag,
    Type extends any,
    Data extends BACNetAppData<Tag, Type> | BACNetAppData<Tag, Type>[],
>(
    type: BDPropertyType,
    identifier: PropertyIdentifier,
): BDAbstractProperty<Tag, Type, Data>
Type Parameters
- Tag extends ApplicationTag
- Type extends any
- Data extends BACNetAppData<Tag, Type> | BACNetAppData<Tag, Type>[]
Parameters
- type: BDPropertyType
- identifier: PropertyIdentifier
Returns BDAbstractProperty<Tag, Type, Data>
Overrides AsyncEventEmitter.constructor
- Defined in src/properties/abstract.ts:56

Properties

`Readonly`identifier

identifier: PropertyIdentifier

The BACnet identifier for this property. Must be unique within the properties added to the same object.

`Readonly`type

type: BDPropertyType

Whether the property representes a single value or an array (or list) of values.

See

Methods

addListener

addListener<K extends keyof BDPropertyEvents<Tag, Type, Data>>(
event: K,
cb: EventListener<BDPropertyEvents<Tag, Type, Data>, K>,
): void
Alias for on
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, Data>
Parameters
- event: K
- cb: EventListener<BDPropertyEvents<Tag, Type, Data>, K>
Returns void
Inherited from AsyncEventEmitter.addListener
- Defined in src/events.ts:60

`Abstract`getData

getData(ctx?: BDPropertyAccessContext): Data
Consumer-facing method to retrieve property data. Implementations of this method should encapsulate retrieval logic as a task that is executed via this property's task queue.
Parameters
- Optionalctx: BDPropertyAccessContext
Returns Data
- Defined in src/properties/abstract.ts:68

on

on<K extends keyof BDPropertyEvents<Tag, Type, Data>>(
event: K,
cb: EventListener<BDPropertyEvents<Tag, Type, Data>, K>,
): BDAbstractProperty<Tag, Type, Data>
Adds a new listener for the specified event.
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, Data>
Parameters
- event: K
  The event name to subscribe to
- cb: EventListener<BDPropertyEvents<Tag, Type, Data>, K>
  The callback function to execute when the event is triggered
Returns BDAbstractProperty<Tag, Type, Data>
The callback function for chaining
Inherited from AsyncEventEmitter.on
- Defined in src/events.ts:48

`Abstract`setData

setData(data: Data): Promise<void>
Consumer-facing method to set property data. Implementations of this method should encapsulate retrieval logic as a task that is executed via this property's task queue.
Parameters
- data: Data
Returns Promise<void>
- Defined in src/properties/abstract.ts:75