Wondering what’s next for npm?Check out our public roadmap! »

    @wordpress/deprecated
    TypeScript icon, indicating that this package has built-in type declarations

    2.12.2 • Public • Published

    Deprecated

    Deprecation utility for WordPress. Logs a message to notify developers about a deprecated feature.

    Installation

    Install the module

    npm install @wordpress/deprecated --save

    This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

    Hook

    The deprecated action is fired with three parameters: the name of the deprecated feature, the options object passed to deprecated, and the message sent to the console.

    Example:

    import { addAction } from '@wordpress/hooks';
    
    function addDeprecationAlert( message, { version } ) {
    	alert( `Deprecation: ${ message }. Version: ${ version }` );	
    }
    
    addAction( 'deprecated', 'my-plugin/add-deprecation-alert', addDeprecationAlert );

    API

    # default

    Logs a message to notify developers about a deprecated feature.

    Usage

    import deprecated from '@wordpress/deprecated';
    
    deprecated( 'Eating meat', {
    	since: '2019.01.01'
    	version: '2020.01.01',
    	alternative: 'vegetables',
    	plugin: 'the earth',
    	hint: 'You may find it beneficial to transition gradually.',
    } );
    
    // Logs: 'Eating meat is deprecated since version 2019.01.01 and will be removed from the earth in version 2020.01.01. Please use vegetables instead. Note: You may find it beneficial to transition gradually.'

    Parameters

    • feature string: Name of the deprecated feature.
    • options [Object]: Personalisation options
    • options.since [string]: Version in which the feature was deprecated.
    • options.version [string]: Version in which the feature will be removed.
    • options.alternative [string]: Feature to use instead
    • options.plugin [string]: Plugin name if it's a plugin feature
    • options.link [string]: Link to documentation
    • options.hint [string]: Additional message to help transition away from the deprecated feature.

    # logged

    Object map tracking messages which have been logged, for use in ensuring a message is only logged once.

    Type

    • Record<string, true | undefined>



    Code is Poetry.

    Install

    npm i @wordpress/deprecated

    DownloadsWeekly Downloads

    20,301

    Version

    2.12.2

    License

    GPL-2.0-or-later

    Unpacked Size

    74.4 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar