canIUse

my.canIUse(String)

说明：mPaaS 10.1.32 及以上版本支持该接口。


判断当前小程序的 API、入参或返回值、组件、属性等在当前版本是否支持。

入参

参数使用 ${API}.${type}.${param}.${option} 或者 ${component}.${attribute}.${option} 方式来调用。

  • API 表示 API 名字，不包括 my. 的名称。例如：您想判断 my.getFileInfo，您只需传入 getFileInfo 即可。
  • type 取值 object/return/callback，表示 API 的判断类型。
  • param 表示参数的某一个属性名。
  • option 表示参数属性的具体属性值。
  • component 表示组件名称。
  • attribute 表示组件属性名。
  • option 表示组件属性值。

代码示例

  1. // 新增 API 是否可用
  2. my.canIUse('getFileInfo')
  3. // API 新增属性是否可用
  4. my.canIUse('closeSocket.object.code')
  5. // API 新增属性是否可用
  6. my.canIUse('getLocation.object.type')
  7. // API 返回值新增属性是否可用
  8. my.canIUse('getSystemInfo.return.brand')
  9. // 新增组件「关注生活号」是否可用
  10. my.canIUse('lifestyle')
  11. // 组件新增属性值是否可用
  12. my.canIUse('button.open-type.share')

返回值

为 Boolean 类型，表示是否支持。