Class Surge

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

Index

Constructors

Methods

update falling rising

Constructors

constructor

new Surge(): kit.Surge

Returns kit.Surge

Methods

update

update(value: number): number | null
Feeds a value in and returns the size of a step past the limit, or null.
Parameters
- value: number
Returns number | null
- Defined in native/index.d.ts:3448

`Static`falling

falling(limit: number): kit.Surge
Creates a detector for falls of more than limit between readings.
Parameters
- limit: number
Returns kit.Surge
- Defined in native/index.d.ts:3446

`Static`rising

rising(limit: number): kit.Surge
Creates a detector for rises of more than limit between readings.
Parameters
- limit: number
Returns kit.Surge
- Defined in native/index.d.ts:3444