Skip to content
On this page

图标描述

方法状态描述

  • Stable (✅): 表示该方法是稳定的,不太可能在未来的版本中发生重大变化。建议用户放心使用。

  • Deprecated (❌): 表示该方法已被弃用,不再建议使用,通常因为有更好的替代方法。在使用过时方法时会收到警告,建议尽快迁移到新方法。

  • Experimental (🚧): 表示该方法处于实验性阶段,可能会在未来的版本中进行更改或改进。不建议在生产环境中广泛使用,仅用于尝试或测试。

  • Unstable (⚠️): 表示该方法不太稳定,可能会在未来的版本中发生较大变化,不建议在生产环境中使用。

  • Obsolete (🚫): 表示该方法已过时,不再维护,并且可能已从代码库中删除。不建议使用。

  • Preview (🔍): 表示该方法是预览方法,还没有更新处于测试阶段,无法使用。

  • Node (🟩): 表示该方法是Node库的方法,不会做具体的介绍,详细用法请自查。

方法权限描述

  • Permissions (🔒): 表示该方法需要一些特定的权限才能使用

方法参数描述

  • Required (⭐): 表示该参数必须填写

方法返回值描述

  • Success (🟢): 表示该返回值是理想的

  • Fail (🔴): 表示该返回值不是理想的

方法特殊描述

  • Danger (🚨): 表示该方法是个危险方法,可能引发未知问题