WordPress的折旧实用程序。记录一条消息,通知开发人员有关已弃用功能的信息。
安装模块
npm install@wordpress/deprecated--保存
此包假定您的代码将在2015年+环境。如果您使用的环境对此类语言功能和API的支持有限或不支持,您应该包括polyfill发货@wordpress/babel预设
在代码中。
这个已弃用
操作由三个参数触发:不推荐使用的功能的名称、传递给不推荐使用的选项对象以及发送到控制台的消息。
例子:
从“@wordpress/hooks”导入{addAction};函数addDeprecationAlert(消息,{version}){警报(`Deprecation:${message}.Version:${Version}`);}添加操作(“已弃用”,'我的插件/添加弃用警报',添加折旧警报);
记录一条消息,通知开发人员有关已弃用功能的信息。
用法
从“@wordpress/已弃用”导入已弃用;不赞成(“吃肉”{自:2019.01.01版本:'2020.01.01',替代选项:“蔬菜”,插件:“地球”,提示:“你可能会发现逐渐过渡是有益的。”,} );//日志:“自2019.01.01版本以来,吃肉已被弃用,并将在2020.01.01版本中从地球上移除。请改用蔬菜。注意:你可能会发现逐步过渡是有益的。”
参数
- 特征
一串
:不推荐使用的功能的名称。
- 选项
[对象]
:个性化选项
- 选项自起
[字符串]
:功能已弃用的版本。
- 选项.版本
[字符串]
:将删除功能的版本。
- 选项.替代
[字符串]
:要使用的功能
- 选项.插件
[字符串]
:插件名称(如果是插件功能)
- 选项.link
[字符串]
:指向文档的链接
- 选项.hint
[字符串]
:有助于从弃用功能过渡的附加消息。
对象映射跟踪已记录的消息,用于确保消息只记录一次。
类型
记录<string,true|undefined>
这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值并由使用WordPress(文字出版社)以及其他软件项目。
要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容投稿人指南.