Socket
Socket
Sign inDemoInstall

deprecatejs

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

deprecatejs

Wrapper to deprecate JavaScript functions. Displays a custom error message if consumers call a function you've marked as deprecated


Version published
Weekly downloads
4
Maintainers
1
Weekly downloads
 
Created
Source

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 - 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.

Keywords

FAQs

Package last updated on 28 Jul 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc