@dinofe/xt-core

Home > @dinofe/xt-core

# xt-core package

一个基础库，包含：提取的一些常用工具方法，Axios二次封装、基础方法等

# Remarks

主要包括五大模块：

  • common: 常用基础方法

  • http: 基于 Axios 的网络请求封装

  • url: Url 相关的方法

  • web: 仅 Web 环境支持的方法

  • wechat: 微信业务相关方法

# Enumerations

Enumeration Description
EncryptVersion 数据加密版本
MIME_TYPE MIME 类型
StorageType 存储类型
WxScope 微信授权scope

# Functions

Function Description
appendBaiscUrl(basicUrl, url) 拼接接口业务域名
appendImageUrl(imgBasicUrl, url) 拼接图片基础域名
base64ToBlob(data, mimeType, sliceSize) Base64 (opens new window) 字符串转为 Blob (opens new window)
convertBlobToUrl(blob) 文件对象转为 URL 链接
copyToClipboard(text) 复制文本到剪贴板
createBaseHttp(baseConfig, config) 创建基础 HTTP 实例
createHttp(config) 根据配置创建 HTTP 实例
createUploadHttp(appConfig, config) 创建上传文件 HTTP 实例（Web 环境）
decodeOAuthUrl(url) 解析微信 oAuth 链接中的配置参数
delay(time) 延迟
div(arg1, arg2) 两浮点数相除
floatDivide(arg1, arg2) 两浮点数相除
floatMultiply(arg1, arg2) 两浮点数相乘
genMessageId() 生成 21 位长度的消息 ID
genOAuthUrl(options) 根据配置生成带有微信oAuth的链接
genRedirectUrl(options) 根据配置生成encode编码好的url地址
getQuery(str, a) 获取url中参数值
getStorageSize(type) 获取 Stroage (opens new window) 存储占用空间的大小
isBlobUrlLike(url) 校验字符串是否是 URL.createObjectURL (opens new window) 返回的链接
isDef(a) 是否为有效的值
isEncodeURILike(url) 判断给定的 URI 是否是 URIEncode (opens new window) 过的
isEndWithSlash(a) 字符串是否以'/'结尾
isFormData(a) 是否为 FormData (opens new window) 对象
isFunction(a) 是否为函数
isNormalObject(a) 是否为普通对象
isNumber(a) 是否为有效 Number (opens new window)
isPromise(a) 是否为 Promise (opens new window) 对象
isStartWithSlash(a) 字符串是否以'/'开头
isString(a) 是否为字符串
isUndef(a) 是否为未定义
isUrlLike(url) 校验字符串是否是 URL 链接
isValidToken(token) 校验 token 格式是否正确
loadImage(url, isBase64, baseUrl) 加载图片为 Image (opens new window) 对象
minus(arg1, arg2) 两数相减
noop() 空函数
plus(arg1, arg2) 两数相加
promisify(a) 转换为已 resolved 的 Promise (opens new window) 对象
randomNumber(len) 生成随机数字符串
rotateImage(image, degree) 旋转图片（沿顺时针非任意角度）
runWithDelayedLoading(asyncTask, { loadingDelay, minLoadingDuration, onLoading, onSettled, }) 带延迟加载提示的异步任务处理方法
runWithTimeout(fn, timeout, context, args) 判断传入的函数执行是否超时
times(arg1, arg2) 两浮点数相乘
toNonExponential(num) 将科学计数法的数字转为字符串
validateIndexedDBOpenable() 判断当前环境下 indexedDB (opens new window) 是否可用
validateStorageAvailable(type) 判断 Stroage (opens new window) 存储是否可用

# Interfaces

Interface Description
ApisauceConfig
ApisauceInstance
BaseTransform BaseTransform
CustomConfig HTTP 自定义配置
IImageSize IImageSize
IRunWithDelayedLoadingOptions IRunWithDelayedLoading
IStorageSize 存储空间占用大小
UploadInstance UploadInstance
XApisauceInstance HTTP 实例

# Variables

Variable Description
Big 解决JS计算精度问题的类
COPY_FAIL_MESSAGE 复制失败提示信息
divide 两浮点数相除
getImageSize 获取图片尺寸
multiply 两浮点数相乘
RETURN_CODE_FAIL 业务处理失败状态码
RETURN_CODE_SUCCESS 业务处理成功状态码

# Type Aliases

Type Alias Description
ApiResponse
AppConfig AppConfig
AsyncRequestTransform
AsyncResponseTransform
Authorization Authorization
BaseConfig 基础 HTTP 配置
BasicUrlConfig BasicUrlConfig
BooelanString BooelanString
CustomAxiosRequestConfig 带有自定义配置项的AxiosConfig
DecodeOAuthUrlResponse DecodeOAuthUrlResponse
FailMessageType 业务失败类型
HttpConfig HTTP 配置
Monitor
PROBLEM_CODE
RedirectUrlConfig RedirectUrlConfig
RequestTransform
ResponseTransform
SObject SObject
UploadAppConfig UploadAppConfig
UploadData UploadData
UploadHttpConfig 上传 HTTP 配置
UploadRequestConfig UploadRequestConfig
WechatBaseConfig WechatBaseConfig
WechatOption WechatOption
XApiResponse XApiResponse
XAsyncRequestTransform 异步请求request转换钩子
XRequestTransform XRequestTransform
XResponseTransform 同步详情response转换钩子