www.aleph1.co.uk Git - yaffs-website/blob - node_modules/deprecated/README.md

   1 # 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]
   2
   3
   4 ## Information
   5
   6 <table>
   7 <tr>
   8 <td>Package</td><td>deprecated</td>
   9 </tr>
  10 <tr>
  11 <td>Description</td>
  12 <td>Tool for deprecating things</td>
  13 </tr>
  14 <tr>
  15 <td>Node Version</td>
  16 <td>>= 0.9</td>
  17 </tr>
  18 </table>
  19
  20 ## Usage
  21
  22 ```javascript
  23 var oldfn = function(a,b) {
  24   return a+b;
  25 };
  26
  27 // returns a new wrapper function that logs the deprecated function once
  28 var somefn = deprecated('dont use this anymore', console.log, oldfn);
  29
  30 var someobj = {};
  31
  32 // set up a getter/set for field that logs deprecated message once
  33 deprecated('dont use this anymore', console.log, someobj, 'a', 123);
  34
  35 console.log(someobj.a); // 123
  36 ```
  37
  38 [npm-url]: https://npmjs.org/package/deprecated
  39 [npm-image]: https://badge.fury.io/js/deprecated.png
  40
  41 [travis-url]: https://travis-ci.org/wearefractal/deprecated
  42 [travis-image]: https://travis-ci.org/wearefractal/deprecated.png?branch=master
  43
  44 [coveralls-url]: https://coveralls.io/r/wearefractal/deprecated
  45 [coveralls-image]: https://coveralls.io/repos/wearefractal/deprecated/badge.png
  46
  47 [depstat-url]: https://david-dm.org/wearefractal/deprecated
  48 [depstat-image]: https://david-dm.org/wearefractal/deprecated.png
  49
  50 [david-url]: https://david-dm.org/wearefractal/deprecated
  51 [david-image]: https://david-dm.org/wearefractal/deprecated.png?theme=shields.io