@uni-helper/uni-promises
v0.5.3
Published
uni-app Promise 化的 API
Readme
@uni-helper/uni-promises
uni-app promise 化的 API。要求 node >= 14.18。
不想看文档?直接问 AI 🤖
起步
安装依赖
安装依赖。
npm install @uni-helper/uni-promises不考虑支持 uni_modules。
使用
调用方式和原生 uni API 一样,只是把 success、fail 回调换成了 await。
import { request } from "@uni-helper/uni-promises";
const { data } = await request({ url: "https://example.com" });request、uploadFile、downloadFile 返回的 Promise 上还挂着原生 task 的方法,可以在 await 之外订阅响应头、分块数据和上传下载进度,也可以用 promise.abort() 取消任务。
import { request } from "@uni-helper/uni-promises";
const promise = request({ url: "https://example.com" });
promise.onChunkReceived(({ data }) => {
// data 是分块收到的 ArrayBuffer
});
await promise;createMapContext、getApp 这类 API 本身返回 Promise,解析出来的对象上的回调式方法也已经 Promise 化。
import { createMapContext } from "@uni-helper/uni-promises";
const context = await createMapContext("map");
const { longitude, latitude } = await context.getCenterLocation({});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
- getBackgroundAudioManager
- getBatteryInfo
- getBeacons
- getBLEDeviceCharacteristics
- getBLEDeviceRSSI
- getBLEDeviceServices
- 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
- readBLECharacteristicValue
- redirectTo
- reLaunch
- removeSavedFile
- removeStorage
- removeTabBarBadge
- request
- requestMerchantTransfer
- requestPayment
- requestSubscribeMessage
- requestVirtualPayment
- saveFile
- saveImageToPhotosAlbum
- saveVideoToPhotosAlbum
- scanCode
- sendSocketMessage
- setBackgroundColor
- setBackgroundTextStyle
- setBLEMTU
- 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
这些没有封装:不走 success 回调的 API(同步方法、on* / off* 事件监听、createAnimation 这类返回实例对象的方法),以及 hideToast、hideLoading、stopPullDownRefresh、hideKeyboard、closeAuthView。后五个官方类型里没有 options 对象,推不出返回值,直接调用 uni.* 就行。
构建
目前 @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/[email protected] 开始提供基于 Promise 的类型定义,但它不能正确地同时支持 Vue 2 和 Vue 3,需要手动适配。而这个库基于回调方法封装 Promise,能正确地同时支持 Vue 2 和 Vue 3。
在官方提供的类型定义不能覆盖这个库之前,这个库依旧尽力保持维护。
