AwaitChangeFilterDefinition | HubHazard Core

An in-progress HubitatDeviceTriggerDefinition builder class.

Hierarchy

AwaitChangeFilterDefinition

Index

Methods

changes

changes(): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:36
Adds a change filter that accepts all attribute's value changes.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(201)
    .where('level')
    .changes(),
];
```
Returns WithAttributesDefinition

customFilter

customFilter(filterFunction: HubitatEventMatchFunction): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:263
Adds a change filter with custom filtering function.

Parameters
- filterFunction: HubitatEventMatchFunction
  
  A function that decides what events is accepted (=> true) and what event is rejected (=> false).
Returns WithAttributesDefinition

decreased

decreased(): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:251
Adds a change filter that accepts only current attribute's value only when it decreased in comparison to the previous one.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .decreased(),
];
```
Returns WithAttributesDefinition

increased

increased(): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:231
Adds a change filter that accepts only current attribute's value only when it increased in comparison to the previous one.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .increased(),
];
```
Returns WithAttributesDefinition

is

is(value: string | number | null): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:55
Adds a change filter that accepts only current attribute's value equal to the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(185)
    .where('level')
    .is(50),
];
```
Parameters
- value: string | number | null
  
  A value of the attribute that is required to match the trigger.
Returns WithAttributesDefinition

isGreaterThan

isGreaterThan(value: number): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:145
Adds a change filter that accepts only current attribute's value greater than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .isGreaterThan(15),
];
```
Parameters
- value: number
  
  A value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

isLesserThan

isLesserThan(value: number): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:189
Adds a change filter that accepts only current attribute's value lesser than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .isLesserThan(15),
];
```
Parameters
- value: number
  
  A value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

isNot

isNot(value: string | number | null): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:100
Adds a change filter that accepts only current attribute's value other than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .isNot(100),
];
```
Parameters
- value: string | number | null
  
  A value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

was

was(value: string | number | null | undefined): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:78
Adds a change filter that accepts only previous attribute's value equal to the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(60)
    .where('level')
    .was(50),
];
```
Parameters
- value: string | number | null | undefined
  
  A previous value of the attribute that is required to match the trigger.
Returns WithAttributesDefinition

wasGreaterThan

wasGreaterThan(value: number): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:167
Adds a change filter that accepts only previous attribute's value greater than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .wasGreaterThan(15),
];
```
Parameters
- value: number
  
  A value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

wasLesserThan

wasLesserThan(value: number): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:211
Adds a change filter that accepts only previous attribute's value lesser than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(119)
    .where('level')
    .wasLesserThan(15),
];
```
Parameters
- value: number
  
  A value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

wasNot

wasNot(value: string | number | null | undefined): WithAttributesDefinition

- Defined in src/hubitat-device-events/definition-building/await-change-filter.definition.ts:123
Adds a change filter that accepts only previous attribute's value other than the one specified.
example
```
readonly triggers = [
  HubitatDeviceTrigger.for(67)
    .where('level')
    .wasNot(100),
];
```
Parameters
- value: string | number | null | undefined
  
  A previous value of the attribute that is not allowed to match the trigger.
Returns WithAttributesDefinition

Hierarchy

Index

Methods

Methods

changes

Returns WithAttributesDefinition

customFilter

Parameters

filterFunction: HubitatEventMatchFunction

Returns WithAttributesDefinition

decreased

Returns WithAttributesDefinition

increased

Returns WithAttributesDefinition

is

Parameters

value: string | number | null

Returns WithAttributesDefinition

isGreaterThan

Parameters

value: number

Returns WithAttributesDefinition

isLesserThan

Parameters

value: number

Returns WithAttributesDefinition

isNot

Parameters

value: string | number | null

Returns WithAttributesDefinition

was

Parameters

value: string | number | null | undefined

Returns WithAttributesDefinition

wasGreaterThan

Parameters

value: number

Returns WithAttributesDefinition

wasLesserThan

Parameters

value: number

Returns WithAttributesDefinition

wasNot

Parameters

value: string | number | null | undefined

Returns WithAttributesDefinition