aboutsummaryrefslogtreecommitdiff
path: root/node_modules/deprecated/README.md
blob: 493e6ea5f3fbd6df566e0743ee8d9e9f63b51afb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# deprecated [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Dependency Status][david-image]][david-url]


## Information

<table>
<tr> 
<td>Package</td><td>deprecated</td>
</tr>
<tr>
<td>Description</td>
<td>Tool for deprecating things</td>
</tr>
<tr>
<td>Node Version</td>
<td>>= 0.9</td>
</tr>
</table>

## Usage

```javascript
var oldfn = function(a,b) {
  return a+b;
};

// returns a new wrapper function that logs the deprecated function once
var somefn = deprecated('dont use this anymore', console.log, oldfn);

var someobj = {};

// set up a getter/set for field that logs deprecated message once
deprecated('dont use this anymore', console.log, someobj, 'a', 123);

console.log(someobj.a); // 123
```

[npm-url]: https://npmjs.org/package/deprecated
[npm-image]: https://badge.fury.io/js/deprecated.png

[travis-url]: https://travis-ci.org/wearefractal/deprecated
[travis-image]: https://travis-ci.org/wearefractal/deprecated.png?branch=master

[coveralls-url]: https://coveralls.io/r/wearefractal/deprecated
[coveralls-image]: https://coveralls.io/repos/wearefractal/deprecated/badge.png

[depstat-url]: https://david-dm.org/wearefractal/deprecated
[depstat-image]: https://david-dm.org/wearefractal/deprecated.png

[david-url]: https://david-dm.org/wearefractal/deprecated
[david-image]: https://david-dm.org/wearefractal/deprecated.png?theme=shields.io