@wordpress/deprecated
Version:
Deprecation utility for WordPress.
55 lines • 1.57 kB
TypeScript
/**
* Object map tracking messages which have been logged, for use in ensuring a
* message is only logged once.
*/
export declare const logged: Record<string, true>;
type DeprecatedOptions = {
/**
* Version in which the feature was deprecated.
*/
since?: string;
/**
* Version in which the feature will be removed.
*/
version?: string;
/**
* Feature to use instead.
*/
alternative?: string;
/**
* Plugin name if it's a plugin feature.
*/
plugin?: string;
/**
* Link to documentation.
*/
link?: string;
/**
* Additional message to help transition away from the deprecated feature.
*/
hint?: string;
};
/**
* Logs a message to notify developers about a deprecated feature.
*
* @param {string} feature Name of the deprecated feature.
* @param {DeprecatedOptions} [options] Personalisation options
*
* @example
* ```js
* 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.'
* ```
*/
export default function deprecated(feature: string, options?: DeprecatedOptions): void;
export {};
//# sourceMappingURL=index.d.ts.map