# @vinka/sweeper

> Sweeper

Latest version **1.0.1** (published 2017-08-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vinka/sweeper
pnpm add @vinka/sweeper
yarn add @vinka/sweeper
bun add @vinka/sweeper
```

## 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.1 |
| Published | 2017-08-16 |
| First published | 2017-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vinka |
| Maintainers | vinka |

## Links

- npm: https://www.npmjs.com/package/@vinka/sweeper
- Repository: https://github.com/vinka-labs/sweeper
- Homepage: https://github.com/vinka-labs/sweeper#readme
- Issues: https://github.com/vinka-labs/sweeper/issues
- npm.io page: https://npm.io/package/@vinka/sweeper

## Recent versions

- 1.0.1 (latest) — 2017-08-16
- 1.0.0 — 2017-08-11

## README

# Sweeper

## Usage

```javascript

const Sweeper = require('@vinka/sweeper');

class MyGreeter extends Sweeper {
    constructor() {
        super(
            'greeter',  // just name used for optional logging
            5000,  // sweep interval in milliseconds
            {
                log: require('winston'),  // optional logger
                firstInterval: 10000,     // optionally define different interval for the first sweep
            });
    }

    // this gets called in every 5000ms. after started
    run() {
        console.log('HELLO');
    }
};

const notifier = new Sweeper();
notifier.start();
setTimeout(() => notifier.stop(), 30 * 1000);

```

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