Module rx-operators

A set of RXJS pipe-able operator to operator on streams of events from Home Assistant.

Index

Functions

Functions

attribute

attribute<AT>(key: string): OperatorFunction<HassEntityBase, AT>

- Defined in src/rx-operators/attribute.ts:12
Plucks a attribute from a home assistant entity.

Type parameters
- AT
  
  Type of the attribute.
Parameters
- key: string
  
  Property key of the attribute.
Returns OperatorFunction<HassEntityBase, AT>

Value of the attribute

newState

newState<T>(): OperatorFunction<StateChangedEvent<T>, T>

- Defined in src/rx-operators/newState.ts:12
Plucks the new state from a emitted StateChangedEvent.

Type parameters
- T: HassEntityBase
  
  Type of the entity that has changed state.
Returns OperatorFunction<StateChangedEvent<T>, T>

The new state from the StateChangedEvent.

state

state<ST>(): OperatorFunction<HassEntityBase, ST>

- Defined in src/rx-operators/state.ts:12
Plucks the state value from an entity.

Type parameters
- ST
  
  The type of the state value (always represented as a string in Home Assistant)
Returns OperatorFunction<HassEntityBase, ST>

The state value

Generated using TypeDoc