小程序开放平台
文档中心
小程序
控制台
登录
指南
框架
组件
JS API
服务端 API
常见问题
基础
canIUse
base64ToArrayBuffer
arrayBufferToBase64
系统
getSystemInfo
getSystemInfoSync
小程序
生命周期
getLaunchOptionsSync
getEnterOptionsSync
应用级事件
onUnhandledRejection
onPageNotFound
onError
onAppShow
onAppHide
offUnhandledRejection
offPageNotFound
offError
offAppShow
offAppHide
更新
getUpdateManager
UpdateManager
applyUpdate
onCheckForUpdate
onUpdateFailed
onUpdateReady
路由
navigateBack
navigateTo
reLaunch
redirectTo
switchTab
openXhsDeeplink
跳转
restartMiniProgram
exitMiniProgram
转发
hideShareMenu
showShareMenu
getShareInfo
界面
交互
hideLoading
hideToast
showActionSheet
showLoading
showToast
showModal
TabBar
hideTabBar
setTabBarItem
setTabBarStyle
showTabBar
导航栏
setNavigationBarColor
setNavigationBarTitle
hideHomeButton
下拉刷新
startPullDownRefresh
stopPullDownRefresh
动画
createAnimation
Animation
菜单
getMenuButtonBoundingClientRect
字体
loadFontFace
网络
发起请求
request
上传
uploadFile
uploadTask
uploadTaskAbort
uploadTaskOffHeadersReceived
uploadTaskOffProgressUpdate
uploadTaskOnHeadersReceived
uploadTaskOnProgressUpdate
uploadXhsFile
下载
downloadFile
WebSocket
sendSocketMessage
onSocketOpen
onSocketMessage
onSocketError
onSocketClose
connectSocket
closeSocket
SocketTask
SocketTask事件
SocketTask-close
SocketTask-onClose
SocketTask-onError
SocketTask-onMessage
SocketTask-onOpen
SocketTask-send
支付
requestGuaranteeOrderPayment
数据缓存
clearStorage
clearStorageSync
getStorage
getStorageInfo
getStorageInfoSync
removeStorage
getStorageSync
setStorage
setStorageSync
媒体
图片
chooseImage
previewImage
getImageInfo
saveImageToPhotosAlbum
compressImage
地图
createMapContext
MapContext
视频
createVideoContext
VideoContext
chooseVideo
chooseMedia
saveVideoToPhotosAlbum
compressVideo
getVideoInfo
富文本
createEditorContext
EditorContext
位置
getLocation
startLocationUpdate
startLocationUpdateBackground
stopLocationUpdate
onLocationChange
chooseLocation
openLocation
开放接口
登录
checkSession
login
授权
authorize
设置
getSetting
openSetting
收货地址
chooseAddress
用户信息
getUserProfile
帐号信息
getAccountInfoSync
引导关注
followOfficialAccount
专业号
openUserProfile
服务组件
xhs.createReservation
直播预约/跳转/打开
直播预约/跳转/回放
设备
剪贴板
getClipboardData
setClipboardData
网络
getNetworkType
电话
makePhoneCall
内存
onMemoryWarning
offMemoryWarning
扫码
scanCode
屏幕
setVisualEffectOnCapture
getScreenRecordingState
onUserCaptureScreen
offUserCaptureScreen
XHSML
createIntersectionObserver
intersectionObserver
createSelectorQuery
SelectorQuery
nodeRef
性能
getPerformance
getEntries
getEntriesByName
getEntriesByType
getCurrentPageEntries
getEntriesByPage
mark
clearMarks
PerformanceEntry
createObserver
PerformanceObserver
第三方平台
getExtConfig
getExtConfigSync
文件
removeSavedFile
openDocument
getFileSystemManager
FileSystemManager方法
access
accessSync
appendFile
appendFileSync
copyFile
copyFileSync
getSavedFileList
getFileInfo
mkdir
mkdirSync
readdir
readdirSync
rmdir
rmdirSync
rename
renameSync
readFile
readFileSync
removeSavedFile
stat
statSync
saveFile
saveFileSync
truncate
truncateSync
unlink
unlinkSync
unzip
writeFile
writeFileSync
Stats
Stats.isFile
Stats.isDirectory
Stats
FileStats
错误码
数据分析
reportAnalytics
画布
canvas
createCanvasContext
canvasPutImageData
canvasGetImageData
canvasToTempFilePath
CanvasContext
setFillStyle
setStrokeStyle
setShadow
createLinearGradient
createCircularGradient
addColorStop
setLineWidth
setLineCap
setLineJoin
setLineDash
setMiterLimit
rect
fillRect
strokeRect
clearRect
fill
stroke
beginPath
closePath
moveTo
lineTo
arc
scale
rotate
translate
setFontSize
fillText
setTextAlign
setTextBaseline
drawImage
setGlobalAlpha
measureText
strokeText
setLineDashOffset
bezierCurveTo
quadraticCurveTo
save
restore
draw
setTransform
xhs.canIUse
开发
>
JS API
>
基础
>
canIUse
>
更新时间:2024-11-13 21:03:27
以Promise风格调用: 不支持。
判断小程序的API,回调,参数,组件等是否在当前版本可用
参数
Object object
属性
类型
默认值
必填
说明
canIUseString
string
是
使用 ${API}.${method}.${param}.${option} 或者 ${component}.${attribute}.${option} 方式来调用
data参数说明
${API}
代表 API 名字
${method}
代表调用方式,有效值为return, success, object, callback
${param}
代表参数或者返回值
${option}
代表参数的可选值或者返回值的属性
${component}
代表组件名字
${attribute}
代表组件属性
${option}
代表组件属性的可选值
实例代码
js
复制代码
xhs.canIUse('request')
该文档是否对您有帮助?
参数
Object object
data参数说明
实例代码