# vibrant

> stream to the vibrate api

Latest version **0.0.1** (published 2014-02-17) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2014-02-17 |
| First published | 2014-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | jesse keane |
| Maintainers | jarofghosts |
| Keywords | vibrate, stream |

## Links

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

## Dependencies (1)

- [through](https://npm.io/package/through.md) ~2.3.4

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2014-02-17
- 0.0.0 — 2014-02-17

## README

vibrant
====

[![Build Status](https://travis-ci.org/jarofghosts/vibrant.png?branch=master)](https://travis-ci.org/jarofghosts/vibrant)

stream data to the browser's `vibrate()` api

## example

```js
var vibrant = require('vibrant')()

vibrant.write([1000, 1000])
```

## notes

data written to vibrant will be streamed unmodified

vibrant takes a number of optional arguments `vibrant(pause, vibrate, timeout)`

* `pause`: the default time to pause after a vibration sequence if none is
specified. (defaults to 0)
* `vibrate`: the function to call to handle vibration, may be passed an array
or a number. (defaults to `navigator.vibrate || navigator.mozVibrate`)
* `timeout`: the function used to schedule vibration. (defaults to
`setTimeout`)

## license

MIT

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