# intervalometer

> Call a function at every frame or every X ms. With start/stop

Latest version **1.0.6** (published 2024-08-21) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2024-08-21 |
| First published | 2016-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Federico Brigante |
| Maintainers | fregante |
| Keywords | frame, interval, requestanimationframe, setinterval, settimeout, start, stop, timeout |

## Links

- npm: https://www.npmjs.com/package/intervalometer
- Repository: https://github.com/fregante/intervalometer
- Homepage: https://github.com/fregante/intervalometer#readme
- Issues: https://github.com/fregante/intervalometer/issues
- Funding: https://github.com/sponsors/fregante
- npm.io page: https://npm.io/package/intervalometer

## Alternatives

- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K weekly downloads
- [persona-harness](https://npm.io/package/persona-harness.md) — 4.7K weekly downloads
- [@tsparticles/effect-bubble](https://npm.io/package/@tsparticles/effect-bubble.md) — 4.6K weekly downloads
- [f3d](https://npm.io/package/f3d.md) — 730 weekly downloads
- [spark-html-motion](https://npm.io/package/spark-html-motion.md) — 298 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2024-08-21
- 1.0.5 — 2019-04-23
- 1.0.4 — 2017-04-27
- 1.0.3 — 2017-04-10
- 1.0.2 — 2016-10-06
- 1.0.1 — 2016-10-06
- 1.0.0 — 2016-10-06

## README

# intervalometer

> Call a function at every frame or every X ms. With start/stop

[![gzipped size](https://badges.herokuapp.com/size/github/fregante/intervalometer/master/dist/intervalometer.browser.js?gzip=true&label=gzipped%20size)](#readme)
[![Travis build](https://api.travis-ci.org/fregante/intervalometer.svg)](https://travis-ci.org/fregante/intervalometer)
[![npm link](https://img.shields.io/npm/v/intervalometer.svg)](https://www.npmjs.com/package/intervalometer)

## Usage

There are two times of intervalometers: frame-based and time-based. Both return an object with `start` and `stop` functions. You can safely call `start` multiple times, the callback will only run once at every interval.

### `frameIntervalometer(cb)`

Uses `requestAnimationFrame` and therefore calls the provided callback at every frame. Ideal for animations

```js
const painter = frameIntervalometer(function (millisecondsSinceLastFrame) {
	// your logic to run at every frame
});

button.onclick = function () {
	painter.start();
};
```

### `timerIntervalometer(cb, ms)`

uses `setTimeout` and calls the callback every `ms` milliseconds

```js
const poller = timerIntervalometer(pollingFunction, 100); //runs every 100 ms

startButton.onclick = function () {
	poller.start();
};
stopButton.onclick = function () {
	poller.stop();
};
```

## Install

Pick your favorite:

```html
<script src="dist/intervalometer.browser.js"></script>
<!-- use as intervalometer.frameIntervalometer(cb) -->
<!--     or intervalometer.timerIntervalometer(cb, ms) -->
```

```sh
npm install --save intervalometer
```

```js
var i = require('intervalometer');
var frameIntervalometer = i.frameIntervalometer;
var timerIntervalometer = i.timerIntervalometer;
```

```js
import {frameIntervalometer, timerIntervalometer} from 'intervalometer';
```

## Dependencies

None! `frameIntervalometer` only works where `window.requestAnimationFrame` is available (yes in modern browsers; not in Node)

## Related

* [iphone-inline-video](https://github.com/fregante/iphone-inline-video/): `video[playsinline]` polyfill that uses this module.
* [animate-prop](https://github.com/fregante/animate-prop): Single low-level function to tween any property over time.

## License

MIT © [Federico Brigante](https://fregante.com)

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