# complain
> Mark methods as deprecated and warn the user when they're called
Latest version **1.6.1** (published 2024-08-26) · MIT license · 0 weekly downloads
## Install
```sh
npm install complain
pnpm add complain
yarn add complain
bun add complain
```
## 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.6.1 |
| Published | 2024-08-26 |
| First published | 2016-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Michael Rawlings |
| Maintainers | henriquelimas, glin1111, alberg.gu, ebay-opensource, gchads, malhan, davidvc, yufwang, lulavalva, sendlo, ebay-owner, ianmcburnie, mlrawlings, dylanpiercey, supnate, tibalt, akleinsteiber, fgoris, scttdavs, agliga, dimichgh, abiyasa, sdepold |
| Keywords | deprecate, complain |
## Links
- npm: https://www.npmjs.com/package/complain
- Repository: https://github.com/mlrawlings/complain
- Homepage: https://github.com/mlrawlings/complain#readme
- Issues: https://github.com/mlrawlings/complain/issues
- npm.io page: https://npm.io/package/complain
## Dependencies (1)
- [error-stack-parser](https://npm.io/package/error-stack-parser.md) ^2.0.1
## Recent versions
- 1.6.1 (latest) — 2024-08-26
- 1.6.0 — 2019-06-19
- 1.5.0 — 2019-06-12
- 1.4.0 — 2019-05-15
- 1.3.0 — 2018-07-02
- 1.2.0 — 2017-11-01
- 1.1.0 — 2017-11-01
- 1.0.0 — 2016-12-14
## README
# complain
Mark methods as deprecated and warn the user when they're called. Forked from [brianc/node-deprecate](https://github.com/brianc/node-deprecate).
## api
`var complain = require('complain');`
### complain()
`complain([String message1 [, String message2 [,...]]], [Object options])`
Call `complain` 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
1 │ var complain = require('complain');
2 │
3 │ var someDeprecatedFunction = function() {
4 │ complain('someDeprecatedFunction() is deprecated');
5 │ };
6 │
… │ // …
30 │
31 │ someDeprecatedFunction();
```
_program output:_
#### Options
- **`location`**: a string in the format `${filepath}:${line}:${column}` indicating where the deprecated function was called from. Setting this to `false` disables outputting the location and will only log the message once.
- **`locationIndex`**: a number indicating the distance (in stack frames) from the call to complain to use as the deprecated location. 0 is the call to complain. By default, it is 1, which is typically the call to the deprecated function.
- **`level`**: a number indicating the log level. 1 = notice. 2 = warning (default).
- **`heading`**: a string that will be printed in color above the message. By default, "WARNING" when `level === 2` or "NOTICE" when `level === 1`.
- **`headingColor`**: a string that is an ansi color/format. By default, `colors.warning` when `level === 2` or `colors.notice` when `level === 1`.
### complain.method()
`complain.method(Object proto, String methodName, [String message1 [, String message2 [,...]]], [Object options])`
Deprecates a method on an object:
```js
complain.method(console, 'log', 'You should not log.');
```
### complain.fn()
`complain.fn(Function func, [String message1 [, String message2 [,...]]], [Object options])`
Deprecates a function and returns it:
```js
console.log = complain.fn(console.log, 'You should not log.');
```
### complain.color
Set to `false` to disable color output. Set to `true` to force color output. Defaults to the value of `complain.stream.isTTY`.
### complain.colors
Controls the colors used when logging. Default value:
```js
{
warning: '\x1b[31;1m', // red, bold
notice: '\x1b[33;1m', // yellow, bold
message: false, // use system color
location: '\u001b[90m' // gray
}
```
_How the default looks on a dark background vs. a light background:_
### complain.silence
When `true`, do nothing when the complain method is called.
### complain.stream
The to which output is written. Defaults to `process.stderr`.
### complain.log(message)
The function used to log, by default this function writes to `complain.stream` and falls back to `console.warn`.
You can replace this with your own logging method.
### complain.getModuleName(location)
The function that determines if a warning is coming from a `node_module`. If the location for a warning is inside a dependent module, a single generic warning is logged once per module. You can replace this with your own function for environments (like browsers) that might not have `node_modules` in the path.
## environment variables
### `SHOW_MODULE_COMPLAINS`
By default, deprecation warnings whose caller location is in a dependent module will not be logged. A single module-level warning will be logged per module that is using deprecated apis. If you wish to view the individual warnings, set this variable to a truthy value.
```
SHOW_MODULE_COMPLAINS=1 node app.js
```
### `SHOW_NESTED_COMPLAINS`
By default, if a deprecated function is using other deprecated apis, there will only be a warning for the top-level call to the deprecated function. If you wish to view the nested warnings, set this variable to a truthy value.
```
SHOW_NESTED_COMPLAINS=1 node app.js
```
## license
MIT
---
_Source: https://npm.io/package/complain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._