## HighWaterMark ⇐ EventEmitter **Kind**: global class **Extends**: EventEmitter * [HighWaterMark](#HighWaterMark) ⇐ EventEmitter * [new HighWaterMark([options])](#new_HighWaterMark_new) * [.value](#HighWaterMark+value) ⇒ number * [.store(value)](#HighWaterMark+store) * [.reset()](#HighWaterMark+reset) * ["newHigh"](#HighWaterMark+event_newHigh) ⇒ number ### new HighWaterMark([options]) Track a high water mark by all-time, time interval or count | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | object | | | | [options.mode] | string | "all" | All time: 'all', Time limited: 'time', Count limited: 'count' | | [options.invert] | boolean | false | When true tracks the low water mark instead of the high | | [options.timeLimit] | integer | 60000 | When mode = 'time' the amount of time over which the high water mark is monitored (ms) | | [options.countLimit] | integer | 10 | When mode = 'count' the number of items over which the high water mark is monitored | ### highWaterMark.value ⇒ number Get the current high water mark **Kind**: instance property of [HighWaterMark](#HighWaterMark) **Returns**: number - Value of high water mark **Read only**: true ### highWaterMark.store(value) Store a new value to the high water mark **Kind**: instance method of [HighWaterMark](#HighWaterMark) **Emits**: [newHigh](#HighWaterMark+event_newHigh) | Param | Type | | --- | --- | | value | number | ### highWaterMark.reset() Reset the high water mark. Deletes all history if using mode = time or count **Kind**: instance method of [HighWaterMark](#HighWaterMark) ### "newHigh" ⇒ number A new high water mark has been reached **Kind**: event emitted by [HighWaterMark](#HighWaterMark) **Returns**: number - Value of new high water mark