# deprecate

> Mark methods as deprecated and warn the user when they're called

Latest version **1.1.1** (published 2019-07-25) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-07-25 |
| First published | 2013-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/deprecate) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Brian M. Carlson |
| Maintainers | brianc |
| Keywords | deprecate |

## Links

- npm: https://www.npmjs.com/package/deprecate
- Repository: https://github.com/brianc/node-deprecate
- Homepage: https://github.com/brianc/node-deprecate#readme
- Issues: https://github.com/brianc/node-deprecate/issues
- npm.io page: https://npm.io/package/deprecate

## Recent versions

- 1.1.1 (latest) — 2019-07-25
- 1.1.0 — 2018-08-29
- 1.0.0 — 2016-08-18
- 0.1.0 — 2013-03-07

## README

# deprecate

[![Build Status](https://secure.travis-ci.org/brianc/node-deprecate.png?branch=master)](http://travis-ci.org/brianc/node-deprecate)

Mark a method as deprecated.  Write a message to a stream the first time the deprecated method is called.

## api

`var deprecate = require('deprecate');`

### deprecate([string message1 [, string message2 [,...]]])

Call `deprecate` within a function you are deprecating.  It will spit out all the messages to the console the first time _and only the first time_ the method is called.

```js
var deprecate = require('deprecate');

var someDeprecatedFunction = function() {
  deprecate('someDeprecatedFunction() is deprecated');
};

someDeprecatedFunction();
someDeprecatedFunction();
someDeprecatedFunction();
console.log('end');

//program output:

WARNING!!
someDeprecatedFunction() is deprecated


end
```

### deprecate.color

Set to `false` to not output a color.  Defaults to `'\x1b[31;1m'` which is red.

### deprecate.silence

Set to `false` to do nothing at all when the deprecate method is called.  Useful in tests of the library you're deprecating things within.

### deprecate.stream

The stream to which output is written.  Defaults to `process.stderr`

## license

MIT

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