# settler

> Settle a number down to 0 over time with an overridable tween.

Latest version **1.0.3** (published 2014-12-03) · BSD license · 0 weekly downloads

## Install

```sh
npm install settler
pnpm add settler
yarn add settler
bun add settler
```

## 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.3 |
| Published | 2014-12-03 |
| First published | 2014-01-13 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kory Nunn |
| Maintainers | korynunn |

## Links

- npm: https://www.npmjs.com/package/settler
- Repository: https://github.com/KoryNunn/settler
- Issues: https://github.com/KoryNunn/settler/issues
- npm.io page: https://npm.io/package/settler

## Recent versions

- 1.0.3 (latest) — 2014-12-03
- 1.0.2 — 2014-12-03
- 1.0.1 — 2014-12-03
- 1.0.0 — 2014-12-03
- 0.0.1 — 2014-01-13
- 0.0.0 — 2014-01-13

## README

# settler

Settle a number towards another number over time with an overridable tween.

## Usage

    npm install settler

```javascript

var Settler = require('settler');

var settler = new Settler();

settler.on('frame', function(value){
    console.log(value);
});

settler.on('settle', function(){
    console.log('done');
});

settler.settle(100);

// Will log a few times from 100 to 0.

```

You can cancel a settle with ```.cancel()``` and listen for the event:


```javascript

settler.on('cancel', function(value){
    console.log('cancled');
});

settler.cancel();

```

You can override any defaults on the instance via the constructor or just manually:


```javascript

var Settler = require('settler');

var settler = new Settler({
    target: 50,
    tween: function(value, distance){
        return distance / 10; // get one tenth closer to the target each 'frame'
    }
});

// later...

settler.target = 300;

```

And more, read the source for more interesting usage.

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