# simple-event-statistics

> Simple statistics supports counting events, store events and fetch events. The Core idea is that this module is cleared after a certain amount of time - and its content is logged.

Latest version **1.0.0** (published 2017-12-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install simple-event-statistics
pnpm add simple-event-statistics
yarn add simple-event-statistics
bun add simple-event-statistics
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-12-28 |
| First published | 2017-12-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Michael Vogt |
| Maintainers | michu |

## Links

- npm: https://www.npmjs.com/package/simple-event-statistics
- Repository: https://github.com/neophob/simple-statistics
- Homepage: https://github.com/neophob/simple-statistics#readme
- Issues: https://github.com/neophob/simple-statistics/issues
- npm.io page: https://npm.io/package/simple-event-statistics

## Recent versions

- 1.0.0 (latest) — 2017-12-28

## README

# Simple statistics

Simple statistics supports counting events, store events and fetch events. The Core idea is
that this module is cleared after a certain amount of time - and its content is logged.

## Example Code

```
const Statistics = require('./index.js');
const statistics = new Statistics();
statistics.setValue('hostname', 'foo');
statistics.increaseCounter('event 1');
statistics.increaseCounter('event 2', 50);
statistics.addErrorMessage('ERROR_EOF');
statistics.addErrorMessage('INVALID_PARAMETER');

const eventsLastHour = statistics.getStatistic();
const errorsLastHour = statistics.getLastErrors();
statistics.clearStatistics();

```

Result:

```
> eventsLastHour
{ 'event 1': 1, 'event 2': 50, hostname: 'foo' }
> errorsLastHour
{ '0': 'ERROR_EOF', '1': 'INVALID_PARAMETER' }
```

## API

### Constructor

- `new Statistics({ errorEntriesToTrack: 10 });`: The parameter is optional, default `errorEntriesToTrack` is set to 10.

### setValue

- `statistics.setValue(key, value);`: Sets key to value, existing keys will be overwritten.

### increaseCounter

- `statistics.increaseCounter(key);`: increase key number, if key was not defined before, it will be initialised to 1.
- `statistics.increaseCounter(key, increaseNumber);`: increase key number, if key was not defined before, it will be initialised to `increaseNumber`.

### addErrorMessage

- `statistics.addErrorMessage(error);`: adds an error message. If more than `errorEntriesToTrack` are added, the oldest entry gets overwritten.

### getStatistic

- `statistics.getStatistic()`: returns the collected events as JSON object.

### getLastErrors

- `statistics.getLastErrors()`: returns the collected errors as JSON object.

### clearStatistics

- `statistics.clearStatistics()`: Cleans error and event statistics.

---
_Source: https://npm.io/package/simple-event-statistics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._