Licence
MIT
Version
0.4.0
Deps
1
Size
229 kB
Vulns
0
Weekly
260
@uni-helper/uni-promises
uni-app promise 化的 API。要求 node >= 14.18。
起步
安装依赖
安装依赖。
npm install @uni-helper/uni-promisesyarn v2/v3
请参考 文档 设置 nodeLinker 为 node_modules。
pnpm
请参考 文档 设置 shamefully-hoist 为 true。
不考虑支持 uni_modules。
API
- addPhoneContact
- authorize
- canvasGetImageData
- canvasPutImageData
- canvasToTempFilePath
- checkIsSoterEnrolledInDevice
- checkIsSupportSoterAuthentication
- checkSession
- chooseAddress
- chooseFile
- chooseImage
- chooseInvoice
- chooseInvoiceTitle
- chooseLocation
- chooseMedia
- chooseMessageFile
- chooseVideo
- clearStorage
- closeBLEConnection
- closeBluetoothAdapter
- closePreviewImage
- closeSocket
- compressImage
- compressVideo
- configMTLS
- connectSocket
- createBLEConnection
- createCameraContext
- createCanvasContext
- createInnerAudioContext
- createLivePlayerContext
- createLivePusherContext
- createMapContext
- createMediaContainer
- createPushMessage
- createSelectorQuery
- createVideoContext
- downloadFile
- getApp
- getBLEDeviceCharacteristics
- getBLEDeviceRSSI
- getBLEDeviceServices
- getBackgroundAudioManager
- getBeacons
- getBatteryInfo
- getBluetoothAdapterState
- getBluetoothDevices
- getCheckBoxState
- getClipboardData
- getConnectedBluetoothDevices
- getExtConfig
- getFileInfo
- getImageInfo
- getLocation
- getNetworkType
- getProvider
- getPushClientId
- getRecordManager
- getSavedFileInfo
- getSavedFileList
- getScreenBrightness
- getSelectedTextRange
- getSetting
- getStorage
- getStorageInfo
- getSystemInfo
- getUserInfo
- getUserProfile
- getVideoInfo
- hideHomeButton
- hideNavigationBarLoading
- hideShareMenu
- hideTabBar
- hideTabBarRedDot
- loadFontFace
- login
- makePhoneCall
- navigateBack
- navigateBackMiniProgram
- navigateTo
- navigateToMiniProgram
- notifyBLECharacteristicValueChange
- openAppAuthorizeSetting
- openBluetoothAdapter
- openDocument
- openLocation
- openSetting
- openVideoEditor
- pageScrollTo
- preLogin
- previewImage
- reLaunch
- readBLECharacteristicValue
- redirectTo
- removeSavedFile
- removeStorage
- removeTabBarBadge
- request
- requestMerchantTransfer
- requestPayment
- requestSubscribeMessage
- requestVirtualPayment
- saveFile
- saveImageToPhotosAlbum
- saveVideoToPhotosAlbum
- scanCode
- sendSocketMessage
- setBLEMTU
- setBackgroundColor
- setBackgroundTextStyle
- setClipboardData
- setEnableDebug
- setKeepScreenOn
- setNavigationBarColor
- setNavigationBarTitle
- setScreenBrightness
- setStorage
- setTabBarBadge
- setTabBarItem
- setTabBarStyle
- share
- shareWithSystem
- showActionSheet
- showLoading
- showModal
- showNavigationBarLoading
- showShareMenu
- showTabBar
- showTabBarRedDot
- showToast
- startAccelerometer
- startBeaconDiscovery
- startBluetoothDevicesDiscovery
- startCompass
- startFacialRecognitionVerify
- startGyroscope
- startLocationUpdate
- startLocationUpdateBackground
- startPullDownRefresh
- startSoterAuthentication
- stopAccelerometer
- stopBeaconDiscovery
- stopBluetoothDevicesDiscovery
- stopCompass
- stopGyroscope
- stopLocationUpdate
- switchTab
- uploadFile
- vibrate
- vibrateLong
- vibrateShort
- writeBLECharacteristicValue
构建
目前 @uni-helper/uni-promises 会使用 tsdown 将 uni API 之外的部分转译到 ES2017（即 ES8）。uni API 需要在项目构建时由 uni-app 官方提供的插件处理。
对于兼容性支持，请查看 https://uni-helper.js.org/vitesse-uni-app/getting-started/deployment#%E5%85%BC%E5%AE%B9%E6%80%A7。
贡献
欢迎参与贡献，请阅读 贡献指南。
延伸
如果你觉得这个库有用，你可以到 这个 ISSUE 投票，鼓励官方引入支持。
尽管 @dcloudio/types@3.3.0 开始提供基于 Promise 的类型定义，但它不能正确地同时支持 Vue 2 和 Vue 3，需要手动适配。而这个库基于回调方法封装 Promise，能正确地同时支持 Vue 2 和 Vue 3。
在官方提供的类型定义不能覆盖这个库之前，这个库依旧尽力保持维护。