@oeos-components/utils 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -1 +1,309 @@
-export * from "/Users/andy/cyrd/oeos-components/packages/utils/src/index";
+import * as element_plus from 'element-plus';
+
+/**
+ * 现有方法如下
+ * $toast(message, type: string | object = 'success', otherParams: object = {})
+ * setStorage(storageName: string, params: any, isSession = false)
+ * getStorage(data, isSession = false)
+ * clearStorage(str: string | [] | object = '')
+ * validForm(ref, { message = '表单校验错误, 请检查', detail = false, showMessage = true } = {})
+ * isEmpty(data: any): boolean
+ * notEmpty(v: any): boolean
+ * merge(obj1: object, obj2: object): object
+ * clone(data, times = 1)
+ * formatTime(time, cFormat = '{y}-{m}-{d} {h}:{i}:{s}')
+ * formatDurationTime(timestamp, cFormat = '{d} 天 {h} 时 {i} 分 {s} 秒')
+ * uuid(type = '',length = 4,{ emailStr = '@qq.com', timeStr = '{m}-{d} {h}:{i}:{s}', startStr = '', optionsIndex = null } = {},)
+ * getType(type)
+ * sleep(delay = 0, fn?: () => void)
+ * validate(type = 'required', rules = {}, pureValid = false)
+ * asyncWrapper(func, ...args)
+ * formatImg(photoName, addPath = '', { basePath = 'assets/images' } = {})
+ * copy = (text, toastParams = {})
+ * formatThousands(number)
+ * log(variableStr, variable, otherInfo = '')
+ * random(min = 0, max = 10)
+ * toLine(text, connect = '-')
+ * processWidth(initValue, isBase = false)
+ * formatBytes(bytes)
+ * formatBytesConvert(bytes)
+ * throttle(fn, delay = 1000)
+ * debounce(fn, delay = 1000)
+ * confirm(message, options)
+ * formatNewLines(str)
+ * getVariable('--green')
+ */
+declare const isString: (val: any) => val is string;
+declare const isStringNumber: (val: string) => boolean;
+declare const isNumber: (val: any) => val is number;
+/**
+ * @example
+  proxy.$toast('保存成功')
+  proxy.$toast('保存失败', 'e')
+  proxy.$toast({
+    message: 'andy',
+    type: 'warning',
+  })
+* $toast.success('This is a success message')
+* @example 显示对象
+* $toast({
+    dangerouslyUseHTMLString: true,
+    message: `<h6>复制成功</h6><pre>${JSON.stringify(obj, null, 2)}</pre>`,
+    type: 'success',
+    duration: 5000,
+  })
+*/
+declare function $toast(message: any, type?: string | object, otherParams?: object): void;
+declare namespace $toast {
+    var success: (message: any, otherParams?: {}) => void;
+    var info: (message: any, otherParams?: {}) => void;
+    var error: (message: any, otherParams?: {}) => void;
+    var warning: (message: any, otherParams?: {}) => void;
+}
+declare function setStorage(storageName: string, params: any, isSession?: boolean): void;
+declare function getStorage(data: any, isSession?: boolean): string | null;
+/**
+ *
+ * @param {*} str 需要清空的localStorage或sessionStorage, 如果不传清空所有
+ * @param {*} param1 需要排除的sessionStorage或者localStorage
+ * @example
+ * clearStorage()
+ * clearStorage('loginId')
+ * clearStorage(['loginId', 'token'])
+ * clearStorage({ exclude: ['loginId', 'token'] })
+ */
+declare function clearStorage(str?: string | [] | object): void;
+declare function validForm(ref: any, { message, detail, showMessage }?: {
+    message?: string | undefined;
+    detail?: boolean | undefined;
+    showMessage?: boolean | undefined;
+}): Promise<unknown>;
+/**
+ * 判断变量是否空值
+ * undefined, null, '', '   ', false, 0, [], {} 均返回true，否则返回false
+ */
+declare function isEmpty(data: any): boolean;
+declare function notEmpty(v: any): boolean;
+/**
+ *  将两个对象合并, 以第二个对象为准, 如果两个对象, 一个属性有值, 一个没值, 合并后有值; 如果两个属性都有值, 以第二个属性为准
+ *  */
+declare function merge(obj1: object, obj2: object): object;
+/**
+ * 克隆数据并根据需要复制数组
+ * @param {any} data - 要克隆的数据
+ * @param {number} [times=1] - 如果是数组，要复制的次数
+ * @returns {any} - 克隆后的数据或复制后的数组
+ * clone(123) => 123
+ * clone([1,2, {name: 'andy'}], 2) => [1, 2, {name: 'andy'}, 1, 2, {name: 'andy'}]
+ */
+declare function clone(data: any, times?: number): any;
+/**
+ * 格式化时间为年月日时分秒的格式， 格式可以自定义。
+ * ① 时间戳10位和13位都可以转换成格式化的日期
+ * ② java8格式的日期和有效的日期都可以转换成定义的日期格式
+ * @param {Date, string}  都有默认参数
+ * @example
+ * formatTime() // 2020-07-17 09:53:07
+ * formatTime('2018-02-13T06:17') // 2018-02-13 06:17:00
+ * formatTime('2020/03/02 06:02') // 2020-03-02 06:02:00
+ * formatTime(1541927611000); //2018-11-11 17:13:21
+ * formatTime(1541927611000, "{y}年{m}月{d}日 {h}时{m}分{s}秒"); // 2018年11月11日 17时11分31秒
+ * formatTime(1541927611, "{y}/{m}/{d} {h}:{m}:{s}"); // 2018/11/11 17:11:31
+ * formatTime(new Date()); //2018-11-11 17:13:21
+ * formatTime(new Date().getTime()); //2018-11-11 17:13:21
+ */
+declare function formatTime(time: any, cFormat?: string): any;
+/**
+ *
+ * @param timestamp 持续的时间戳
+ * @param cFormat 格式化的规则
+ * @returns 天时分秒的字符串
+ * @example
+ * formatDurationTime(1162821) => 19分24秒
+ */
+declare function formatDurationTime(timestamp: any, cFormat?: string): string;
+/**
+ * 生成 UUID
+ * @param {string} [type=''] - 生成 UUID 的类型，可以是 'phone', 'email', 'time', 'number' 或空字符串
+ * @param {number} [length=4] - 生成字符串的长度
+ * @param {object} [options={}] - 额外的选项
+ * @param {string} [options.emailStr='@qq.com'] - 生成 email 时使用的后缀
+ * @param {string} [options.timeStr='{m}-{d} {h}:{i}:{s}'] - 生成时间字符串的格式
+ * @param {string} [options.startStr=''] - 起始字符串
+ * @param {number|null} [options.optionsIndex=null] - 数组索引
+ * @returns {string|number} - 生成的 UUID
+ * uuid("名字") => 名字hc8f
+ * uuid() => abcd
+ * uuid('time') => 25MR 10-27 17:34:01
+ * uuid('time', 0, {startStr:'andy', timeStr:"{h}:{i}:{s}"}) => andy 17:38:23
+ * uuid('phone') => 13603312460
+ * uuid('email') => cBZA@qq.com
+ * uuid('number') => 2319
+ * uuid([ { label: "小泽泽", value: "xzz" },{ label: "小月月", value: "xyy" }]) => xzz
+ */
+declare function uuid(type?: string, length?: number, { emailStr, timeStr, startStr, optionsIndex }?: {
+    emailStr?: string | undefined;
+    timeStr?: string | undefined;
+    startStr?: string | undefined;
+    optionsIndex?: null | undefined;
+}): any;
+/**
+ * 判断传入参数的类型
+ * @param {*} type
+ * getType(new RegExp()) regexp
+ * getType(new Date()) date
+ * getType([]) array
+ * getType({}) object
+ * getType(null) null
+ * getType(123) number
+ */
+declare function getType(type: any): string;
+declare function sleep(delay?: number, fn?: () => void): Promise<unknown>;
+/** @使用方式
+ * 1. 在el-form中使用
+name: [ proxy.validate('name', { message: '你干嘛哈哈' })],
+between: [ proxy.validate('between', { max: 99 })],
+number: [ proxy.validate('number')],
+length: [proxy.validate('length')],
+mobile: [ proxy.validate('mobile')],
+ip: [ proxy.validate('ip')],
+custom: [proxy.validate('custom', { message: '最多保留2位小数', reg: /^\d+\.?\d{0,2}$/ })]
+confirmRegPwd: [
+  proxy.validate('same', { value: form.value.regPwd }),
+], //1. 如果判断两个密码一致, 还要在input输入值改变的时候, 再校验一下两个input
+  formRef.value.validate('regPwd')
+  formRef.value.validate('confirmRegPwd')
+  // 2. rules需要使用computed包裹, 否则值改变无法传递
+ * 2. 在函数中使用, 返回boolean
+ let ip = proxy.validate('ip', 122322, true)
+ let custom = proxy.validate('custom', { value: -123, reg: /^-\d+\.?\d{0,2}$/ }, true)
+*/
+declare function validate(type?: string, rules?: {}, pureValid?: boolean): any;
+/**
+ *
+const { res, err } = await proxy.asyncWrapper(listTests, pickForm);
+if (err) {
+    return;
+}
+ */
+declare function asyncWrapper(func: any, ...args: any[]): Promise<{
+    res: any;
+    err?: undefined;
+} | {
+    err: unknown;
+    res?: undefined;
+}>;
+/** 获取assets静态资源
+ * @example
+ *  proxy.formatImg('1.png')
+ *  proxy.formatImg('1.png', 'menu')
+ *  */
+declare function formatImg(photoName: any, addPath?: string, { basePath }?: {
+    basePath?: string | undefined;
+}): any;
+/**
+ * 复制文本
+ *
+ * copy('这是要复制的文本');
+ * copy('这是要复制的文本', {duration: 500});
+ *
+ *  */
+declare const copy: (text: any, toastParams?: {}) => void;
+/**
+ * 1234 => 1,234
+ * 1234b => 1,234b
+ * 1234.12b => 1,234.12b
+ * @param number 加千分位
+ * @returns
+ */
+declare function formatThousands(number: any): any;
+declare function log(variableStr: any, variable: any, otherInfo?: string): void;
+/**
+ * 生成指定范围内的随机整数
+ *
+ * @param min 最小值，默认为0
+ * @param max 最大值，默认为10
+ * @returns 返回生成的随机整数
+ */
+declare function random(min?: number, max?: number): number;
+/**
+ * 将文本转换为带有连接符的行文本
+ *
+ * @param text 要转换的文本
+ * @param connect 连接符，默认为'-'
+ * @returns 返回转换后的行文本
+ * toLine('NameAndy') // name-andy
+ * toLine('nameAndy') // name-andy
+ * toLine('_nameAndy') // _name-andy
+ */
+declare function toLine(text: any, connect?: string): any;
+declare function processWidth(initValue: any, isBase?: boolean): any;
+/**
+ * 增加小数点
+ * toFixed(22) -> '22.00'
+ * proxy.toFixed('22') -> '22.00'
+ * proxy.toFixed('22', 4) -> '22.0000'
+ * proxy.toFixed('22', 2, true) -> 22
+ */
+declare function toFixed(value: any, digits?: number): any;
+/**
+ * 只有对正整数或者字符串正整数才进行单位的转换,
+ * 否则返回原始数据
+ * proxy.formatBytes(536870912) // 512MB
+ */
+declare function formatBytes(bytes: any, { toFixed, thousands }?: {
+    toFixed?: number | undefined;
+    thousands?: boolean | undefined;
+}): any;
+declare function formatBytesConvert(oBytes: any, { thounsand, toFixed }?: {
+    thounsand?: boolean | undefined;
+    toFixed?: number | undefined;
+}): any;
+declare function throttle(fn: any, delay?: number): () => void;
+declare function debounce(fn: any, delay?: number): () => void;
+/**
+ * proxy.confirm('确定删除吗?')
+ * proxy.confirm('哈哈', { icon: 'el-icon-plus' })
+ * close-on-click-modal: 是否可通过点击遮罩层关闭 MessageBox 默认true
+ * lock-scroll: 是否在 MessageBox 出现时将 body 滚动锁定. 默认true
+ * 设置宽度, 内容使用组件
+   import GWarning from '@/autoComponents/gWarning.vue'
+    await proxy.confirm('', {
+      dangerouslyUseHTMLString: true,
+      customStyle: {
+        maxWidth: '600px',
+      },
+      message: h(GWarning, {
+        content:
+          '对于光存储开启保持原始对象名称后，对象将作为独立文件在光存储介质直接存储。<br>注意：当桶内文件大小普遍较小（<100MB）或过大（>5GB）时不推荐打开此功能！您确定开启此功能吗?',
+      }),
+      showCancelButton: true,
+      cancelButtonText: '取消',
+      appendTo: '#highSettingsForm',
+    })
+ * 如果是多个dialog嵌套, 可以给上层的dom设置个id如highSettingsForm, 然后appendTo: '#highSettingsForm'
+ */
+declare function confirm(message: any, options: any): Promise<element_plus.MessageBoxData>;
+/**
+ * 格式化字符串中的换行符和制表符
+ * @param str 待格式化的字符串
+ * @returns 格式化后的字符串，如果输入的不是字符串或为空，则返回原字符串
+ * @example
+$toast(
+  formatNewLines(
+    'Example file\n  File : 111.jpeg\n  CreateTime : 1721011155921 2024-07-15 10:39:15\n  LastUpdateTime : 1721011155921 2024-07-15 10:39:15\n------------------------------------------------------------------------\nExtract:\n  aa=231\n------------------------------------------------------------------------\n',
+  ),
+  {
+    duration: 5000,
+    dangerouslyUseHTMLString: true,
+  },
+)
+ */
+declare function formatNewLines(str: any): any;
+/** Function to get a CSS custom property value
+ *
+ * getVariable('--blue');
+ *  */
+declare function getVariable(propertyName: any): string;
+
+export { $toast, asyncWrapper, clearStorage, clone, confirm, copy, debounce, formatBytes, formatBytesConvert, formatDurationTime, formatImg, formatNewLines, formatThousands, formatTime, getStorage, getType, getVariable, isEmpty, isNumber, isString, isStringNumber, log, merge, notEmpty, processWidth, random, setStorage, sleep, throttle, toFixed, toLine, uuid, validForm, validate };