deprecate
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/deprecate package

    1.1.1 • Public • Published

    deprecate

    Build Status

    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.

    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

    Keywords

    Install

    npm i deprecate

    DownloadsWeekly Downloads

    360,709

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    5.07 kB

    Total Files

    5

    Last publish

    Collaborators

    • brianc