# beeper

> Make your terminal beep

Latest version **3.0.0** (published 2021-05-03) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 43/100 (D)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-05-03 |
| First published | 2014-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/beeper) |
| Module format | ESM |
| Node | >=12 |
| Dependencies | 1 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 134 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | beep, beeper, boop, terminal, cli, console, ding, ping, alert, gulpfriendly |

## Links

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

## Dependencies (1)

- [yoctodelay](https://npm.io/package/yoctodelay.md) ^1.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2021-05-03
- 2.1.0 — 2021-01-02
- 2.0.0 — 2019-04-08
- 1.1.1 — 2016-11-10
- 1.1.0 — 2015-06-01
- 1.0.0 — 2014-12-01

## README

# beeper

> Make your terminal beep

![](https://cloud.githubusercontent.com/assets/170270/5261236/f8471100-7a49-11e4-81af-96cd09a522d9.gif)

Useful as an attention grabber. For example, when an error happens.

## Install

```
$ npm install beeper
```

## Usage

```js
import beeper from 'beeper';

await beeper();
// beep one time

await beeper(3);
// beep three times

await beeper('****-*-*');
// beep, beep, beep, beep, pause, beep, pause, beep
```

## API

It will not beep if stdout is not TTY or if the user supplies the `--no-beep` flag.

### beeper(count?)
### beeper(melody?)

Returns a `Promise<void>` that is resolved after the melody has ended.

#### count

Type: `number`\
Default: `1`

How many times you want it to beep.

#### melody

Type: `string`

Construct your own melody by supplying a string of `*` for beep `-` for pause.

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