Class Surge

Notices a step change between successive readings, such as a burst pipe.

Index

Constructors

Methods

update falling rising

Constructors

constructor

new Surge(): Surge

Returns Surge

Methods

update

update(value: number): number | null
Feeds a value in and returns the size of a qualifying step, or null.
Parameters
- value: number
Returns number | null
- Defined in index.d.ts:1490

`Static`falling

falling(limit: number): Surge
Creates a detector for falls of at least limit between readings.
Parameters
- limit: number
Returns Surge
- Defined in index.d.ts:1488

`Static`rising

rising(limit: number): Surge
Creates a detector for rises of at least limit between readings.
Parameters
- limit: number
Returns Surge
- Defined in index.d.ts:1486