@wlydfe/pro-ui 0.2.21 → 0.2.24

package/docs/api/utils/is.md

@@ -1,259 +0,0 @@
-## isArray
-
-判断是否是数组
-
-```ts
-/**
- * 判断是否是数组
- */
-declare const isArray: (arg: any) => arg is any[]
-```
-
-使用示例
-
-```ts
-import { isArray } from '@wlydfe/pro-ui-utils'
-
-isArray([]) // true
-```
-
-## isMap
-
-判断是否是 Map
-
-```ts
-/**
- * 判断是否是Map
- * @param val
- * @returns
- */
-declare const isMap: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isMap } from '@wlydfe/pro-ui-utils'
-
-isMap(new Map()) // true
-```
-
-## isSet
-
-判断是否是 Set
-
-```ts
-/**
- * 判断是否是Set
- * @param val
- * @returns
- */
-declare const isSet: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isSet } from '@wlydfe/pro-ui-utils'
-
-isSet(new Set()) // true
-```
-
-## isDate
-
-判断是否是 Date
-
-```ts
-/**
- * 判断是否是Date
- * @param val
- * @returns
- */
-declare const isDate: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isDate } from '@wlydfe/pro-ui-utils'
-
-isDate(new Date()) // true
-```
-
-## isRegExp
-
-判断是否是 Reg
-
-```ts
-/**
- * 判断是否是Reg
- * @param val
- * @returns
- */
-declare const isRegExp: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isRegExp } from '@wlydfe/pro-ui-utils'
-
-isRegExp(new RegExp()) // true
-```
-
-## isFunction
-
-判断是否是函数
-
-```ts
-/**
- * 判断是否是函数
- * @param val
- * @returns
- */
-declare const isFunction: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isFunction } from '@wlydfe/pro-ui-utils'
-
-const func = () => {}
-isFunction(func) // true
-```
-
-## isString
-
-判断是否是字符串
-
-```ts
-/**
- * 判断是否是字符串
- * @param val
- * @returns
- */
-declare const isString: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isString } from '@wlydfe/pro-ui-utils'
-
-isString('str') // true
-```
-
-## isSymbol
-
-判断是否是 Symbol
-
-```ts
-/**
- * 判断是否是Symbol
- * @param val
- * @returns
- */
-declare const isSymbol: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isSymbol } from '@wlydfe/pro-ui-utils'
-
-isSymbol(Symbol('str')) // true
-```
-
-## isObject
-
-判断是否是 object
-
-```ts
-/**
- * 判断是否是object
- * @param val
- * @returns
- */
-declare const isObject: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isObject } from '@wlydfe/pro-ui-utils'
-
-isObject([]) // true
-isObject({}) // true
-isObject(function () {}) // true
-isObject(null) // false
-```
-
-## isPromise
-
-判断是否是 Promise
-
-```ts
-/**
- * 判断是否是Promise
- * @param val
- * @returns
- */
-declare const isPromise: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isPromise } from '@wlydfe/pro-ui-utils'
-
-isPromise(function () {}) // false
-isPromise(new Promise()) // true
-```
-
-## isPlainObject
-
-判断是否是 纯对象 object
-
-```ts
-/**
- * 判断是否是 纯对象 object
- * @param val
- * @returns
- */
-declare const isPlainObject: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isPlainObject } from '@wlydfe/pro-ui-utils'
-
-isPlainObject({}) // true
-isPlainObject([]) // false
-isPlainObject(function () {}) // false
-isPlainObject(null) // false
-```
-
-## isEmptyObject
-
-是否是空纯对象
-
-```ts
-/**
- * 是否是空对象
- * @param val
- * @returns
- */
-declare const isEmptyObject: (val: any) => boolean
-```
-
-使用示例
-
-```ts
-import { isEmptyObject } from '@wlydfe/pro-ui-utils'
-
-isEmptyObject({}) // true
-isEmptyObject({ data: 'data' }) // false
-isEmptyObject([]) // false
-```

package/docs/api/utils/number.md

@@ -1,65 +0,0 @@
-## formatMoney
-
-格式化金钱
-
-```ts
-/**
- * 格式化金钱  ￥12,345,678.00
- * @param val
- * @param format 默认 '￥'
- * @returns
- */
-declare function formatMoney(val: string | number, format?: string): string
-```
-
-使用示例
-
-```ts
-import { formatMoney } from '@wlydfe/pro-ui-utils'
-
-formatMoney('100') // ￥100.00
-```
-
-## formatNumber
-
-格式化数字
-
-```ts
-/**
- * 格式化数字
- * @param number
- * @param  format  默认格式 '0.00'
- * @returns
- */
-declare function formatNumber(number: number | string, format?: string): string
-```
-
-使用示例
-
-```ts
-import { formatNumber } from '@wlydfe/pro-ui-utils'
-
-formatNumber('100') // 100.00
-```
-
-## formatNumberFixed
-
-格式化数字保留几位小数，不会四舍五入
-
-```ts
-/**
- * 格式化数字保留几位小数
- * @param value
- * @param decimal 默认2位小数
- * @returns x.xx
- */
-declare function formatNumberFixed(value: string, decimal?: number): string
-```
-
-使用示例
-
-```ts
-import { formatNumberFixed } from '@wlydfe/pro-ui-utils'
-
-formatNumberFixed('100.12555') // 100.12
-```

package/docs/api/utils/other.md

@@ -1,190 +0,0 @@
-## getBigLetter
-
-生成大写字母
-
-```ts
-/**
- * @desc 生成大写字母
- * @returns
- */
-declare const getBigLetter: () => string[]
-```
-
-使用示例
-
-```ts
-import { getBigLetter } from '@wlydfe/pro-ui-utils'
-
-getBigLetter() // ["A","B","C", "D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"]
-```
-
-## getSmallLetter
-
-生成小写字母
-
-```ts
-/**
- * @desc 生成小写字母
- * @returns
- */
-declare const getSmallLetter: () => string[]
-```
-
-使用示例
-
-```ts
-import { getSmallLetter } from '@wlydfe/pro-ui-utils'
-
-getSmallLetter() // ['a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z']
-```
-
-## WS
-
-WebSocket 支持自动重连，心跳检测
-
-```ts
-/**
- * setTimeout 类型
- */
-type Timeout = ReturnType<typeof setTimeout>
-/**
- * setInterval 类型
- */
-type Interval = ReturnType<typeof setInterval>
-/**
- * 允许null的泛型
- */
-type Nullable<T> = T | null
-type AutoReconnect = {
-  /**
-   *重连尝试次数 默认 3
-   */
-  reconnectMaxCount?: number
-}
-type Heartbeat = {
-  /**
-   * 心跳信息 默认`ping`
-   */
-  message: string
-  /**
-   * 心跳间隔时间 默认 `3000` 毫秒
-   */
-  interval: number
-}
-interface WSOptions {
-  /**
-   * 是否自动重连 默认`true`
-   */
-  autoReconnect: boolean | AutoReconnect
-  /**
-   * 心跳 默认`false`
-   */
-  heartbeat: boolean | Heartbeat
-  /**
-   * url 携带的参数
-   */
-  query: Record<string, string>
-}
-declare class WS {
-  url: string
-  socket: WebSocket | null
-  reconnectCount: number
-  delay: Nullable<Timeout>
-  timer: Nullable<Interval>
-  autoReconnect: WSOptions['autoReconnect']
-  heartbeat: WSOptions['heartbeat']
-  query: WSOptions['query']
-  constructor(url?: string, options?: WSOptions)
-  /**
-   * 连接
-   */
-  connect(): void
-  /**
-   * 监听连接
-   */
-  onOpen(): void
-  /**
-   * 开启心跳
-   */
-  startHeartbeat(): void
-  /**
-   * 监听错误
-   */
-  onError(): void
-  /**
-   * 关闭连接
-   */
-  close(): void
-  /**
-   *  监听消息
-   * @param callback
-   */
-  onMessage(callback: (...data: any[]) => any): void
-  /**
-   * 发送消息
-   * @param data
-   */
-  send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void
-}
-```
-
-使用示例
-
-```ts
-import { WS } from '@wlydfe/pro-ui-utils'
-
-const ws = new WS('ws://domain.com')
-ws.onMessage(data => {
-  console.log(data)
-})
-```
-
-## openExe
-
-打开电脑本地软件
-
-```ts
-/**
- * @description 打开电脑本地软件
- * @param protocol  本地软件协议， 如 vscode 的协议 `vscode://`
- * @param event  点击按钮事件， `el-button` 或者原生 `button`
- * @param timeout 默认`1000`ms，没响应则认为打开失败
- */
-declare const openExe: (protocol: string, event: Event, timeout?: number) => Promise<FocusEvent>
-```
-
-使用示例
-
-```html
-<button @click="handleClick">打开vscode</button>
-```
-
-```ts
-import { openExe } from '@wlydfe/pro-ui-utils'
-
-const url = 'vscode://'
-
-const handleClick = async (event: MouseEvent) => {
-  await openExe(url, event)
-}
-```
-
-## isIOS
-
-是否是 ios
-
-```ts
-/**
- * 是否是ios
- * @returns {boolean}
- */
-declare function isIOS(): boolean
-```
-
-使用示例
-
-```ts
-import { isIOS } from '@wlydfe/pro-ui-utils'
-
-isIOS() // false
-```

package/docs/api/utils/storage.md

@@ -1,117 +0,0 @@
-## setStorage
-
-设置 `localStorage`
-
-```ts
-/**
- * 设置 localStorage
- * @returns storage
- */
-declare function setToken(key: string, token: string): string
-```
-
-使用示例
-
-```ts
-import { setStorage } from '@wlydfe/pro-ui-utils'
-
-setStorage('key', { data: { username: 'name' } })
-```
-
-## getStorage
-
-获取 `localStorage`
-
-```ts
-/**
- * 获取 localStorage
- * @returns storage
- */
-declare function getToken(key: string): string
-```
-
-使用示例
-
-```ts
-import { getStorage } from '@wlydfe/pro-ui-utils'
-
-getStorage('key') // { data: { username: "name" } }
-```
-
-## removeStorage
-
-移除 `localStorage`
-
-```ts
-/**
- * 移除storage
- */
-declare function removeToken(key: string): void
-```
-
-使用示例
-
-```ts
-import { removeStorage } from '@wlydfe/pro-ui-utils'
-
-removeStorage('key')
-```
-
-## setToken
-
-设置 token 带 AES 加密 （存储在 `localStorage`）
-
-```ts
-/**
- * 设置token 带AES加密
- * @returns token
- */
-declare function setToken(key: string, token: string): string
-```
-
-使用示例
-
-```ts
-import { setToken } from '@wlydfe/pro-ui-utils'
-
-setToken('tokenKey', 'token')
-```
-
-## getToken
-
-获取 token 带 AES 解密 （获取的是 `localStorage` 的值）
-
-```ts
-/**
- * 获取token  带AES解密
- * @returns token
- */
-declare function getToken(key: string): string
-```
-
-使用示例
-
-```ts
-import { getToken } from '@wlydfe/pro-ui-utils'
-
-getToken('tokenKey') //  'token'
-```
-
-## removeToken
-
-移除 token （移除的是 `localStorage` 的值）
-
-```ts
-/**
- * 移除token
- */
-declare function removeToken(key: string): void
-```
-
-使用示例
-
-```ts
-import { removeToken } from '@wlydfe/pro-ui-utils'
-
-removeToken('tokenKey')
-```

package/docs/api/utils/validate.md

@@ -1,104 +0,0 @@
-## validateRegexUrl
-
-校验链接地址
-
-```ts
-/**
- * @desc 校验链接地址
- * @param url
- * @returns
- */
-declare function validateRegexUrl(url: string): boolean
-```
-
-使用示例
-
-```ts
-import { validateRegexUrl } from '@wlydfe/pro-ui-utils'
-
-validateRegexUrl('https://www.api.com') // true
-```
-
-## validatePhone
-
-检验电话
-
-```ts
-/**
- * @desc 检验电话
- * @param phone
- * @returns
- */
-declare const validatePhone: (phone: string) => boolean
-```
-
-使用示例
-
-```ts
-import { validatePhone } from '@wlydfe/pro-ui-utils'
-
-validatePhone('18888888888') // true
-```
-
-## validateLocalPhone
-
-检验固定电话
-
-```ts
-/**
- * @desc 检验固定电话
- * @param localPhone
- * @returns
- */
-declare const validateLocalPhone: (localPhone: string) => boolean
-```
-
-使用示例
-
-```ts
-import { validateLocalPhone } from '@wlydfe/pro-ui-utils'
-
-validateLocalPhone('010-88568888-6603') // true
-```
-
-## validateEmail
-
-检验邮箱
-
-```ts
-/**
- * @desc 检验邮箱
- * @param mail
- * @returns
- */
-declare const validateEmail: (mail: string) => boolean
-```
-
-使用示例
-
-```ts
-import { validateEmail } from '@wlydfe/pro-ui-utils'
-
-validateEmail('8888@qq.com') // true
-```
-
-## validateExternal
-
-判断是否是可跳转 URL
-
-```ts
-/**
- * @desc 判断是否是可跳转URL
- * @param {string} path
- * @returns
- */
-declare const validateExternal: (path: string) => boolean
-```
-
-使用示例
-
-```ts
-import { validateExternal } from '@wlydfe/pro-ui-utils'
-
-validateExternal('http://www.api.com') // true
-```