deprecatejs
v1.2.0
Published
Wrapper to deprecate JavaScript functions. Displays a custom error message if consumers call a function you've marked as deprecated
Downloads
9
Readme
DeprecateJS
Example usage:
// someModule
var deprecate = require('deprecatejs');
module.exports = {
oldFunc: deprecate(function (str) {
console.log(str);
}, 'Please use newFunc instead'),
newFunc: function (str) {
...
}
};
var someModule = require('someModule');
someModule.oldFunc('foo.');
// CONSOLE ERROR: - Deprecated Method Call - Anonymous function has been deprecated. Please use newFunc instead
// foo.
In Production: (if we dont want to console error in prod we can pass in a boolean indicating if our env isProduction)
// someModule
var deprecate = require('deprecatejs');
var environment = process.env.NODE_ENV;
// Disable logging in production.
if (environment === 'production') {
deprecate.inProduction();
}
module.exports = {
oldFunc: deprecate(function (str) {
console.log(str);
}, 'Please use newFunc instead'),
newFunc: function (str) {
...
}
};
var someModule = require('someModule ');
someModule.oldFunc('foo.'); //in prod the error is skipped
// foo.