s94-utils 0.0.1 → 0.0.2

package/dist/types/index.d.ts

@@ -0,0 +1,175 @@
+declare class Queue {
+    list: {
+        callback: () => any;
+        thisArg: any;
+    }[];
+    running: number;
+    limit: number;
+    status: number;
+    /**
+     * 构建队列
+     * @param {number} [limit] 同时执行的槽位数量限制，默认为：1
+     * @param {boolean} [start] 构建好后，是否直接开始队列
+     * @returns {Queue}
+     */
+    constructor(limit?: number, start?: boolean);
+    __run(): this;
+    /**
+     * 插入执行
+     * @param {function} callback 回调函数，如果返回 Promise ，会占用执行槽位直到 Promise 兑现
+     * @param {any} thisArg 执行时的this对象
+     * @returns {Queue}
+     */
+    add(callback: () => any, thisArg: any): this;
+    start(): this;
+    stop(): void;
+}
+type TypeCacheEngine = {
+    getItem: (name: string) => string | Promise<string>;
+    setItem: (name: string, data: any) => Promise<any>;
+    removeItem?: (name: string) => Promise<any>;
+    clear?: () => any;
+};
+declare class Cache {
+    Storage: TypeCacheEngine;
+    /**
+     * 构建缓存器，传入缓存引擎对象，
+     * @param { {getItem:(name:string)=>string|Promise<string>, setItem:(name:string, data:any)=>Promise<any>, removeItem?:(name:string)=>Promise<any>, clear?:()=>any } } engine
+     */
+    constructor(engine: TypeCacheEngine);
+    /**
+     * 获取缓存
+     * @param {any} name 缓存名
+     * @param {any} def 默认值
+     * @returns {any | Promise<any>} 由引擎的 getItem 确定是否返回 Promise
+     */
+    get(name: any, def?: any): any;
+    /**
+     * 设定缓存
+     * @param {string} name 缓存名称
+     * @param {any} value 缓存值
+     * @param {number} timeout 过期时间(毫秒)，默认或者小于0，表示永久
+     * @returns {Promise<any>}
+     */
+    set(name: string, value: any, timeout?: number): Promise<any>;
+    /**
+     * 移除缓存
+     * @param {string} name
+     * @returns {Promise<any>}
+     */
+    remove(name: string): Promise<any>;
+    /**
+     * 清理缓存，如果引擎存在 clear 方法，
+     * @returns {Promise<any>}
+     */
+    clear(): Promise<any> | undefined;
+}
+/**
+ * 返回参数的类型，例如 Object，Date
+ * @param {any} obj
+ * @returns {string}
+ */
+declare function var_type(obj: any): string;
+/**
+ * 转字符串
+ * @param {any} val
+ * @returns {string}
+ */
+declare function to_string(val: any): any;
+/**
+ * 去除字符串两边的空白
+ * @param {string} str
+ * @param {string} [mask] 额外需要去除的字符串
+ * @returns {string}
+ */
+declare function trim(str: string, mask?: string): string;
+/**
+ * 计算相对路径
+ * @param {string} path
+ * @param {string} base
+ * @returns {*|string}
+ */
+declare function path(path: string, base: string): string;
+type TypeEachCallback = (v: any, k: string, obj: Object, ks: string[]) => any;
+type TypeEachOption = {
+    each: TypeEachCallback;
+    over?: () => any;
+    limit?: number;
+};
+/**
+ * 遍历对象
+ * @param {Object} obj
+ * @param { TypeEachOption | (v:any, k:string, obj:Object)=>any } op 遍历回调函数 或者 包含遍历回调的配置
+ * @param {any} [thisArg] 回调函数的this对象
+ */
+declare function each(obj: Object, op: TypeEachOption | TypeEachCallback, thisArg: any): void;
+/**
+ * 递归遍历
+ * @param {Object} obj 遍历的对象
+ * @param {string} childkey 递归遍历子对象的参数名，如果为空表示遍历整个子对象
+ * @param { (v:any, k:string, obj:Object, ks:string[])=>any } callback 遍历回调函数
+ * @param {boolean} [is_layer] 是否按层结构（0,1,00,01,10...）递归，false表示按树结构（0,00,01,1,10...）
+ * @param {any} [thisArg] 遍历回调的this，默认为子对象
+ */
+declare function eachloop(obj: Object, childkey: string, callback: TypeEachCallback, is_layer?: boolean, thisArg?: any): void;
+/**
+ * url查询参数解码
+ * @param {string} str url查询参数字符串，例如：a=1&b[]=2&b[]=3
+ * @returns {{[key:string]: string|Object}}
+ */
+declare function param_decode(str: string): {};
+/**
+ * url查询参数编码
+ * @param {Object} obj 数据对象
+ * @returns {string}
+ */
+declare function param_encode(obj: any): string;
+/**
+ * 数据签名
+ * @param {any} data 数据
+ * @param {number} len 长度， 默认64
+ * @returns {string}
+ */
+declare function encode(data: any, len?: number): string;
+/**
+ * 对象的指定值获取 或者 设定
+ * @param {any} data 数据源
+ * @param {string|{[key:string]: any}} key_data 获取的键，或者设定数据的键值对
+ * @param {any} def 值不存在的默认值
+ * @returns {*}
+ */
+declare function map(data: any, key_data: string | {
+    [key: string]: any;
+}, def: any): any;
+type TypeDateReturn = {
+    timestamp: number;
+    y: number;
+    m: number;
+    d: number;
+    h: number;
+    i: number;
+    s: number;
+    w: number;
+    string: string;
+    zone: number;
+};
+/**
+ * 日期处理
+ * @param {string|number|Date} date 日期，可以是字符串、时间戳(毫秒)
+ * @param {string} fmt 日期字符串格式，如果data为字符串，然后fmt为空，那么会推定日期为 年月日时分秒、日月年时分秒 中的一种
+ * @param {number} [zone] 时区，东正，西负。-12~12
+ * @returns {{timestamp: number, y: number, m: number, d: number, h: number, i: number, s: number, w: number, string: string, zone: number}}
+ */
+declare function date(date: string | number | Date, fmt?: string, zone?: number): TypeDateReturn;
+/**
+ * 事件管理，on，off，emit
+ */
+declare const event_manage: {
+    __event_list: {
+        [k: string]: ((data?: any) => any)[];
+    };
+    on(event_name: string, callback: (data?: any) => any, first?: any): void;
+    off(event_name: string, callback: (data?: any) => any): void;
+    emit(event_name: string, data: any, thisArg?: any): void;
+};
+export { Queue, Cache, var_type, to_string, trim, path, each, eachloop, param_decode, param_encode, encode, map, date, event_manage, };

package/package.json

@@ -1,23 +1,36 @@
 {
   "name": "s94-utils",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.0.2",
+  "description": "s94本人常用的工具方法包",
   "type": "module",
-  "main": "src/index.js",
-  "module": "src/index.mjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "import": "src/index.mjs",
-      "require": "src/index.js",
-      "default": "src/index.js"
-    }
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
   },
-  "files": ["src"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "sideEffects": false,
-
   "scripts": {
-    "test": "node test/test.js"
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4"
+  }
 }