utils-lib-js 1.6.1 → 1.6.3

package/README.en.md

@@ -28,33 +28,41 @@ JavaScript工具函数，封装的一些常用的js函数
 接口：
 
 export type IKey = string | symbol | number
-// 对象类型
+
+##### 对象类型
+
 export interface IObject<T> {
     [key: IKey]: T | IObject<any>
 }
+
 export interface IPromise extends IObject<any> {
     promise: Promise<void>
     resolve: (res: any) => unknown
     reject: (err: any) => unknown
 }
+
 export type IInstance<T> = {
     _instance: Function
 } & T
+
 export type IDemoteArray<T> = Array<IDemoteArray<T> | T>
 
-// base
+##### base
+
 /**产生区间随机数
 * @param {number} min  最小区间
 * @param {number} max  最大区间
 * @param {boolean} bool  包含最大值
 * @return {number} 随机数
 **/
+
 export type IRandomNum = (min: number, max: number, bool?: boolean) => number
 
 /**获取url的参数
 * @param {string} url  待截取的地址
 * @return {object} 参数对象
 **/
+
 export type IUrlSplit = (url: string) => IObject<any>
 
 /**添加url的参数
@@ -62,12 +70,14 @@ export type IUrlSplit = (url: string) => IObject<any>
 * @param {object} query  待添加的参数
 * @return {string} 添加参数后的url
 **/
+
 export type IUrlJoin = (url: string, query: object) => string
 
 /**获取数据类型
 * @param {any} data  待检测数据
 * @return {string} 数据类型
 **/
+
 export type IGetType<T> = (data: any) => typeof data | T[keyof T] | "null";
 
 /**批量判断数据类型
@@ -75,16 +85,19 @@ export type IGetType<T> = (data: any) => typeof data | T[keyof T] | "null";
 * @param {any} whiteList  数据类型名单
 * @return {boolean} 是否在白名单中
 **/
+
 export type IGetTypeByList = (data: any, whiteList: string[]) => boolean;
 
 
-// object
+##### object
+
 /**lodash中的 _.get()，获取对象某级属性
 * @param {IObject} object  目标对象
 * @param {string} key  对象层级
 * @param {any} defaultValue  未取得时默认值
 * @return {IObject[IKey]} 对象某个属性
 **/
+
 export type IGetValue = <T, U = IObject<T> | IObject<T>[IKey]>(object: U, key: string, defaultValue?: any) => U
 
 /**lodash中的 _.set()，赋值对象某级属性
@@ -93,6 +106,7 @@ export type IGetValue = <T, U = IObject<T> | IObject<T>[IKey]>(object: U, key: s
 * @param {any} value  需要赋的值
 * @return {IObject} 目标对象
 **/
+
 export type ISetValue = <T>(object: IObject<T>, key: string, value?: any) => IObject<T>
 
 /**对象混入
@@ -101,18 +115,21 @@ export type ISetValue = <T>(object: IObject<T>, key: string, value?: any) => IOb
 * @param {boolean} overwrite  是否重写覆盖原有属性
 * @return {IObject} 目标对象
 **/
+
 export type IMixIn = <U extends IObject<any>>(target?: U, source?: IObject<any>, overwrite?: boolean) => U
 
 /**枚举值反向映射
 * @param {IObject<string>} target  目标对象
 * @return {IObject<string>} 目标对象
 **/
+
 export type IEnumInversion = (target: IObject<string>) => IObject<string>
 
 /**对象复制
 * @param {IObject<any>} target  目标对象
 * @return {IObject} 目标对象
 **/
+
 export type ICloneDeep = (target?: any) => any
 
 /**生成 对象 类型的初始值
@@ -120,18 +137,21 @@ export type ICloneDeep = (target?: any) => any
 * @param {any} __init  初始值
 * @return {any} 目标对象
 **/
+
 export type ICreateObjectVariable = (type: string, source?: any) => any
 
 /**Object.create 根据源对象产出新对象
 * @param {Function|Object} source  源对象
 * @return {Function|Object} 对象产物
 **/
+
 export type ICreateObject = <T, U extends T>(source: T) => U
 
 /**类的继承
 * @param {Function} source  源对象
 * @return {Function} 继承产物
 **/
+
 export type IInherit = <T extends Function>(source: T, target?: Function) => Function
 
 /**生成类的实例单例
@@ -140,32 +160,38 @@ export type IInherit = <T extends Function>(source: T, target?: Function) => Fun
 * @param {any[]} params  构造函数的参数
 * @return {IObject} 实例化的单例
 **/
+
 export type IGetInstance = (classProto: IInstance<FunctionConstructor>, overwrite?: boolean, ...params: any[]) => Function
 
 /**通过装饰器将属性混入类中
 * @param {IObject<any>} params  混入的属性
 * @return {ClassDecorator} 装饰器钩子函数
 **/
+
 export type IClassDecorator = (params: IObject<any>) => <TFunction extends Function>(target: TFunction) => void
 
 /**JSON.parse封装
 * @param {string} target  字符串
 * @return {IObject<any>} 对象
 **/
+
 export type IStringToJson = (target: string) => IObject<any>
 
 /**JSON.stringify封装
 * @param {IObject<any>} target  对象
 * @return {string} 字符串
 **/
+
 export type IJsonToString = (target: IObject<any>) => string
 
-// function
+##### function
+
 /**节流(throttle):高频事件触发，但在 n 秒内只会执行一次
 * @param {Function} fn  节流处理的函数
 * @param {number} time  执行间隔/毫秒
 * @return {Function} 处理后的函数
 **/
+
 export type IThrottle = (fn: Function, time: number) => (...args: any[]) => void
 
 /**防抖(debounce):触发高频事件后 n 秒内函数只会执行一次
@@ -173,31 +199,37 @@ export type IThrottle = (fn: Function, time: number) => (...args: any[]) => void
 * @param {number} time  允许运行函数间隔/毫秒
 * @return {Function} 处理后的函数
 **/
+
 export type IDebounce = (fn: Function, time: number) => (...args: any[]) => void
 
 /**
  * Promise扁平化，避免Promise嵌套
  * @returns {Promise,resolve,reject} 
  */
+
 export type IDefer = () => IPromise
 
 /**await与try catch 捕获异常处理方法
  * @param {Promise<any>} defer  延迟函数
  * @returns {Promise<any>} [error, result]
  */
+
 export type ICatchAwait<T extends Promise<any>> = (defer: T) => T
 
-// array
+##### array
+
 /**数组乱序
  * @param {Array<any>} arr  目标数组
  * @returns {Array<any>} 乱序后的数组
  */
+ 
 export type IArrayRandom<T extends any[]> = (arr: T) => T
 
 /**数组数组去重
  * @param {Array<any>} arr  目标数组
  * @returns {Array<any>} 去重后的数组
  */
+
 export type IArrayUniq<T extends any[]> = (arr: T) => T
 
 /**数组扁平化
@@ -207,44 +239,52 @@ export type IArrayUniq<T extends any[]> = (arr: T) => T
 
 export type IArrayDemote<T extends IDemoteArray<any>> = (arr: T, result?: T) => T
 
-// element
+##### element
+
 /**IElementParams
  * @param {string} ele 标签类型
  * @param {CSSStyleDeclaration} style 样式
  * @param {Attr} attr 属性
  * @param {object} parent 父元素
  */
+
 interface IElementParams<T> {
     ele: T | string
     style: CSSStyleDeclaration
     attr: Attr
     parent: T
 }
+
 /**新增标签，设置属性及样式
  * @param {IElementParams} params 配置
  * @return {ElementObject} 生成的标签
  */
+
 export type ICreateElement<T = HTMLElement> = (params: IElementParams<T>) => T
 
-// event
+##### event
+
 /**浏览器事件
  * @param {Document} ele 标签
  * @param {string} type 事件类型
  * @param {(e: Event) => void} handler 事件回调
  * @return {void}
  */
+
 export type IAddHandler = <T extends Document>(ele: T, type: string, handler: (e: Event) => void) => void
 
 /**取消事件冒泡
  * @param {Event} e 浏览器事件对象
  * @return {void}
  */
+
 export type IStopBubble = (e: Event) => void
 
 /**取消默认事件
  * @param {Event} e 浏览器事件对象
  * @return {void}
  */
+
 export type IStopDefault = (e: Event) => void
 
 /**取消浏览器事件
@@ -253,34 +293,54 @@ export type IStopDefault = (e: Event) => void
  * @param {(e: Event) => void} handler 事件回调
  * @return {void}
  */
+
 export type IRemoveHandler = <T extends Document>(ele: T, type: string, handler: (e: Event) => void) => void
 
 /**取消默认事件
  * @param {Event} e 浏览器事件对象
  * @return {void}
  */
+
 export type IDispatchEvent = <T extends Document>(ele: T, data: any) => void
 
-// request
+##### request
 
 export type IRequestParams<T> = T | IObject<any> | null
+
 // 请求路径
+
 export type IUrl = string
+
 // 环境判断
+
 export type IEnv = 'Window' | 'Node'
+
 // fetch返回取值方式
+
 export type IDataType = "text" | "json" | "blob" | "formData" | "arrayBuffer"
+
 // 请求方式
+
 export type IRequestMethods = "GET" | "POST" | "DELETE" | "PUT" | "OPTION"
+
 // body结构
+
 export type IRequestBody = IRequestParams<BodyInit>
+
 // heads结构
+
 export type IRequestHeaders = IRequestParams<HeadersInit>
+
 // 请求基础函数
+
 export type IRequestBaseFn = (url: IUrl, opts: IRequestOptions) => Promise<any>
+
 // 请求函数体
+
 export type IRequestFn = (url?: IUrl, query?: IObject<any>, body?: IRequestBody, opts?: IRequestOptions) => Promise<any>
+
 // 请求参数
+
 export type IRequestOptions = {
     method?: IRequestMethods
     query?: IRequestParams<IObject<any>>
@@ -291,14 +351,18 @@ export type IRequestOptions = {
     timer?: number | unknown | null
     [key: string]: any
 }
+
 // 拦截器
+
 export type IInterceptors = {
     use(type: "request" | "response" | "error", fn: Function): void
     get reqFn(): Function
     get resFn(): Function
     get errFn(): Function
 }
+
 // 公共函数
+
 export type IRequestBase = {
     readonly origin: string
     chackUrl: (url: IUrl) => boolean
@@ -312,13 +376,17 @@ export type IRequestBase = {
     http: IRequestBaseFn
     getDataByType: (type: IDataType, response: Response) => Promise<any>
 }
+
 // 初始化参数
+
 export type IRequestInit = {
     initDefaultParams: (url: IUrl, opts: IRequestOptions) => any
     initFetchParams: (url: IUrl, opts: IRequestOptions) => any
     initHttpParams: (url: IUrl, opts: IRequestOptions) => any
 }
+
 // 请求主体类
+
 export type IRequest = {
     GET: IRequestFn
     POST: IRequestFn
@@ -328,3 +396,85 @@ export type IRequest = {
     HEAD: IRequestFn
     PATCH: IRequestFn
 } & IRequestBase
+
+
+<!-- 消息中心 -->
+// 消息中心
+export declare interface Handlers {
+    [key: string]: Array<Function>
+}
+export declare interface IMessageCenter {
+    events: Handlers
+    _instance?: IMessageCenter
+    on: (type: string, handler: Function) => this
+    emit: (type: string, data?: any) => this
+    un: (type: string, handler?: Function) => this
+    once: (type: string, handler: Function) => this
+    clear: () => this
+    has: (type: string) => boolean
+    handlerLength: (type: string) => number
+    watch: (type: string, handler: Function) => this
+    invoke: (type: string, data?: any) => Promise<void>
+}
+https://gitee.com/DieHunter/message-center
+
+<!-- 任务队列 -->
+
+/**
+ * 单条队列
+ * defer: 待运行的异步函数
+ * params?: defer的参数，也可以用bind直接传递
+ * 
+ */
+export interface IQueue {
+    defer: Function
+    name?: string
+}
+/**
+ * 队列参数
+ * children: 队列列表
+ * name: 队列唯一标识
+ * result: 运行完成后的结果
+ * 
+ */
+export interface IQueues {
+    children: Array<Function>
+    name: string
+    result?: any[]
+}
+/**
+ * 队列缓存
+ */
+export type IQueueTemp = {
+    [key: string]: IQueues
+}
+/**
+ * 系统队列
+ */
+export type IQueueList = Array<IQueue>
+/**
+ * 队列状态 idle:空闲 pending:等待 fulfilled:完成 rejected:失败
+ */
+export type IState = "idle" | "pending" | "fulfilled" | "rejected"
+/**
+ * 任务队列参数
+ */
+export type ITaskQueueProps = {
+    maxLen: number
+}
+/**
+ * 任务队列
+ */
+export type ITaskQueue = {
+    readonly fix: string
+    props: ITaskQueueProps
+    queueTemp: IQueueTemp
+    queues: IQueueList
+    state: IState
+    push: (queue: IQueues) => Promise<void>
+    unshift: (length: number) => IQueueList
+    run: (reject: any) => unknown
+    clear: () => void
+}
+
+https://gitee.com/DieHunter/task-queue

package/README.md

@@ -396,3 +396,85 @@ export type IRequest = {
     HEAD: IRequestFn
     PATCH: IRequestFn
 } & IRequestBase
+
+
+<!-- 消息中心 -->
+// 消息中心
+export declare interface Handlers {
+    [key: string]: Array<Function>
+}
+export declare interface IMessageCenter {
+    events: Handlers
+    _instance?: IMessageCenter
+    on: (type: string, handler: Function) => this
+    emit: (type: string, data?: any) => this
+    un: (type: string, handler?: Function) => this
+    once: (type: string, handler: Function) => this
+    clear: () => this
+    has: (type: string) => boolean
+    handlerLength: (type: string) => number
+    watch: (type: string, handler: Function) => this
+    invoke: (type: string, data?: any) => Promise<void>
+}
+https://gitee.com/DieHunter/message-center
+
+<!-- 任务队列 -->
+
+/**
+ * 单条队列
+ * defer: 待运行的异步函数
+ * params?: defer的参数，也可以用bind直接传递
+ * 
+ */
+export interface IQueue {
+    defer: Function
+    name?: string
+}
+/**
+ * 队列参数
+ * children: 队列列表
+ * name: 队列唯一标识
+ * result: 运行完成后的结果
+ * 
+ */
+export interface IQueues {
+    children: Array<Function>
+    name: string
+    result?: any[]
+}
+/**
+ * 队列缓存
+ */
+export type IQueueTemp = {
+    [key: string]: IQueues
+}
+/**
+ * 系统队列
+ */
+export type IQueueList = Array<IQueue>
+/**
+ * 队列状态 idle:空闲 pending:等待 fulfilled:完成 rejected:失败
+ */
+export type IState = "idle" | "pending" | "fulfilled" | "rejected"
+/**
+ * 任务队列参数
+ */
+export type ITaskQueueProps = {
+    maxLen: number
+}
+/**
+ * 任务队列
+ */
+export type ITaskQueue = {
+    readonly fix: string
+    props: ITaskQueueProps
+    queueTemp: IQueueTemp
+    queues: IQueueList
+    state: IState
+    push: (queue: IQueues) => Promise<void>
+    unshift: (length: number) => IQueueList
+    run: (reject: any) => unknown
+    clear: () => void
+}
+
+https://gitee.com/DieHunter/task-queue

package/dist/bundle/array.d.ts

@@ -0,0 +1,10 @@
+import { IArrayRandom, IArrayUniq, IArrayDemote, IDemoteArray } from "./index.js";
+export declare const arrayRandom: IArrayRandom<any[]>;
+export declare const arrayUniq: IArrayUniq<any[]>;
+export declare const arrayDemote: IArrayDemote<IDemoteArray<any>>;
+declare const _default: {
+    arrayRandom: IArrayRandom<any[]>;
+    arrayUniq: IArrayUniq<any[]>;
+    arrayDemote: IArrayDemote<IDemoteArray<any>>;
+};
+export default _default;

package/dist/bundle/base.d.ts

@@ -0,0 +1,14 @@
+import { IRandomNum, IUrlSplit, IUrlJoin, IGetType, IGetTypeByList, types } from "./index.js";
+export declare const randomNum: IRandomNum;
+export declare const urlSplit: IUrlSplit;
+export declare const urlJoin: IUrlJoin;
+export declare const getType: IGetType<types>;
+export declare const getTypeByList: IGetTypeByList;
+declare const _default: {
+    randomNum: IRandomNum;
+    urlSplit: IUrlSplit;
+    urlJoin: IUrlJoin;
+    getType: IGetType<types>;
+    getTypeByList: IGetTypeByList;
+};
+export default _default;

package/dist/bundle/element.d.ts

@@ -0,0 +1,6 @@
+import { ICreateElement } from "./index.js";
+export declare const createElement: ICreateElement;
+declare const _default: {
+    createElement: ICreateElement;
+};
+export default _default;

package/dist/bundle/event.d.ts

@@ -0,0 +1,14 @@
+import { IAddHandler, IStopBubble, IStopDefault, IRemoveHandler, IDispatchEvent } from "./index.js";
+export declare const addHandler: IAddHandler;
+export declare const stopBubble: IStopBubble;
+export declare const stopDefault: IStopDefault;
+export declare const removeHandler: IRemoveHandler;
+export declare const dispatchEvent: IDispatchEvent;
+declare const _default: {
+    addHandler: IAddHandler;
+    stopBubble: IStopBubble;
+    stopDefault: IStopDefault;
+    removeHandler: IRemoveHandler;
+    dispatchEvent: IDispatchEvent;
+};
+export default _default;

package/dist/bundle/function.d.ts

@@ -0,0 +1,12 @@
+import { ICatchAwait, IThrottle, IDebounce, IDefer } from "./index.js";
+export declare const throttle: IThrottle;
+export declare const debounce: IDebounce;
+export declare const defer: IDefer;
+export declare const catchAwait: ICatchAwait<Promise<any>>;
+declare const _default: {
+    throttle: IThrottle;
+    debounce: IDebounce;
+    defer: IDefer;
+    catchAwait: ICatchAwait<Promise<any>>;
+};
+export default _default;

package/dist/bundle/index.d.ts

@@ -0,0 +1,51 @@
+export * from "./object.js";
+export * from "./base.js";
+export * from "./array.js";
+export * from "./function.js";
+export * from "./element.js";
+export * from "./static.js";
+export * from "./types.js";
+export * from "./request.js";
+export * from "./event.js";
+export * from "./storage.js";
+export * from "event-message-center";
+export * from "task-queue-lib";
+declare const _default: {
+    setStorage: (key: string, val: any) => void;
+    getStorage: (key: string) => any;
+    clearStorage: (key: string) => void;
+    addHandler: import("./types.js").IAddHandler;
+    stopBubble: import("./types.js").IStopBubble;
+    stopDefault: import("./types.js").IStopDefault;
+    removeHandler: import("./types.js").IRemoveHandler;
+    dispatchEvent: import("./types.js").IDispatchEvent;
+    Request: typeof import("./request.js").Request;
+    types: typeof import("./static.js").types;
+    createElement: import("./types.js").ICreateElement;
+    throttle: import("./types.js").IThrottle;
+    debounce: import("./types.js").IDebounce;
+    defer: import("./types.js").IDefer;
+    catchAwait: import("./types.js").ICatchAwait<Promise<any>>;
+    arrayRandom: import("./types.js").IArrayRandom<any[]>;
+    arrayUniq: import("./types.js").IArrayUniq<any[]>;
+    arrayDemote: import("./types.js").IArrayDemote<import("./types.js").IDemoteArray<any>>;
+    randomNum: import("./types.js").IRandomNum;
+    urlSplit: import("./types.js").IUrlSplit;
+    urlJoin: import("./types.js").IUrlJoin;
+    getType: import("./types.js").IGetType<import("./static.js").types>;
+    getTypeByList: import("./types.js").IGetTypeByList;
+    getValue: import("./types.js").IGetValue;
+    setValue: import("./types.js").ISetValue;
+    mixIn: import("./types.js").IMixIn;
+    enumInversion: import("./types.js").IEnumInversion;
+    isNotObject: (source: any, type: any) => boolean;
+    cloneDeep: import("./types.js").ICloneDeep;
+    createObjectVariable: import("./types.js").ICreateObjectVariable;
+    createObject: import("./types.js").ICreateObject;
+    inherit: import("./types.js").IInherit;
+    getInstance: import("./types.js").IGetInstance;
+    classDecorator: import("./types.js").IClassDecorator;
+    stringToJson: import("./types.js").IStringToJson;
+    jsonToString: import("./types.js").IJsonToString;
+};
+export default _default;