https://github.com/brianc/node-deprecate

Mark a method as deprecated by printing a warning to the console the first time it's called
https://github.com/brianc/node-deprecate

Last synced: about 1 month ago
JSON representation

Mark a method as deprecated by printing a warning to the console the first time it's called

• Host: GitHub
• URL: https://github.com/brianc/node-deprecate
• Owner: brianc
• Created: 2013-03-07T15:21:54.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2019-07-25T18:18:24.000Z (over 5 years ago)
• Last Synced: 2024-09-24T13:06:19.220Z (3 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 14
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-f2e-libs - **deprecate** - 给过期警告。 (命令行 / redux 扩展)
• awesome-fe - **deprecate** - 给过期警告。 (命令行 / macros)

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