devix 0.0.17 → 0.0.18

package/README.md

@@ -1,36 +1,104 @@
 # devix
 
-> Devix is a comprehensive, powerful, and compact JavaScript utility library.
+> devix 是一个全面的、强大的、紧凑的 JavaScript 实用程序库（ 简体中文 | [English](README_en.md) ）
 
-## Install
+## 安装
+
+请确保您在 Node.js 环境下使用 npm 或其他包管理器安装此库。
 
 ```shell
 npm install --save-dev devix
 ```
 
-## Usage
+然后，利用现代的模块捆绑工具，如 Vite 或 Webpack，以模块化的语法引入此库。
 
 ```javascript
-// Using ES Module
+// 使用 ES Module
 import { [[ModuleName]] } from 'devix'
 
-// Using CommonJS
-var { [[ModuleName]]  } = require('devix')
+// 使用 CommonJS
+const { [[ModuleName]]  } = require('devix')
+```
+
+## 使用
+
+```javascript
+import { localCache, bubblingSort, isType } from 'devix'
+
+// 使用 localCache
+localCache.setCache('userInfo', { name: 'king', age: 18 })
+const userInfo = localCache.get('userInfo')
+console.log('userInfo', userInfo)
+
+// 使用 bubblingSort、
+const arr1 = [123, 346, 62, 2456, 56123, 1, 64, 61, 453, 72345]
+const sortArr1 = bubblingSort(arr1, 'DESC')
+console.log('sortArr1', sortArr1)
+const arr2 = [
+  { name: 'zsan', age: 16 },
+  { name: 'lisi', age: 32 },
+  { name: 'wawu', age: 25 },
+  { name: 'king', age: 18 }
+]
+const sortArr2 = bubblingSort(arr2, 'DESC', 'age')
+console.log('sortArr2', sortArr2)
+
+// 使用 isType
+console.log(`isType(userInfo,'object') -> true`, isType(userInfo, 'object'))
+console.log(
+  `isType(userInfo.name,'string') -> true`,
+  isType(userInfo, 'string')
+)
+console.log(`isType(userInfo.age,'number') -> true`, isType(userInfo, 'number'))
 ```
 
-## API
+## 方法
+
+### 缓存相关
+
+提供缓存操作的相关方法。
+
+- localCache
+- sessionCache
+
+### 拷贝相关
+
+用于数据复制操作的相关方法。
+
+- deepClone
+- shallowClone
+
+### 限频相关
+
+包含控制操作触发频率的相关方法。
+
+- throttle
+- debounce
+
+### 排序相关
+
+提供各种排序操作的方法。
 
 - bubblingSort
+
+### 时间相关
+
+包括处理时间相关操作的方法。
+
+- formatTimer
+- setTimer
+
+### 类型相关
+
+用于数据类型检测的相关方法。
+
+- isType
+
+### 其他方法
+
+包括各种其他功能性函数和方法。
+
 - compose
 - currying
-- debounce
-- deepClone
-- formatTimer
 - insertStr
-- isType
-- localCache
-- sessionCache
-- setTimer
-- shallowClone
 - stringCase
-- throttle

package/dist/index.d.ts

@@ -2,9 +2,6 @@ declare function currying(fn: Function): (this: any, ...args: any[]) => any;
 declare function compose(...fns: Function[]): ((this: any, ...args: any[]) => any) | undefined;
 declare function insertStr(soure: string, start: number, newStr: string): string;
 declare function stringCase(soure: string, separator?: string, separate?: string): string;
-declare function setTimer(execute: (...args: any[]) => any, delay?: number, immediate?: boolean): {
-    cancel: () => void;
-};
 
 declare const isType: (type: string, target: any) => boolean;
 
@@ -63,5 +60,8 @@ declare enum SortType {
 declare function bubblingSort<T>(array: T[], type?: SortType, key?: keyof T): T[];
 
 declare const formatTimer: TFormatTimer;
+declare function setTimer(execute: (...args: any[]) => any, delay?: number, immediate?: boolean): {
+    cancel: () => void;
+};
 
 export { bubblingSort, compose, currying, debounce, deepClone, formatTimer, insertStr, isType, localCache, sessionCache, setTimer, shallowClone, stringCase, throttle };

package/dist/index.esm.js

@@ -1,5 +1,5 @@
-function t(t){return function e(...n){return n.length>=t.length?t.apply(this,n):function(...t){return e.apply(this,n.concat(t))}}}function e(...t){const e=t.length;if(!(e<=0)){for(let n=0;n<e;n++){if("function"!=typeof t[n])throw new Error(`argument with index ${n} is not a function`)}return function(...n){let o=0,r=t[o].apply(this,n);for(;++o<e;)r=t[o].call(this,r);return r}}}function n(t,e,n){return t.slice(0,e)+n+t.slice(e)}function o(t,e="",n=""){const o=t.split(e);for(let t=0;t<o.length;t++)o[t]=o[t].slice(0,1).toUpperCase()+o[t].slice(1).toLowerCase();return o.join(n)}function r(t,e=0,n=!1){let o=null;const r=()=>{t(),o=setTimeout(r,e)};return n&&t(),setTimeout(r,e),{cancel:()=>{null!==o&&clearTimeout(o)}}}const c={string:t=>"string"==typeof t,number:t=>"number"==typeof t,boolean:t=>"boolean"==typeof t,null:t=>null===t,undefined:t=>void 0===t,symbol:t=>"symbol"==typeof t,bigint:t=>"bigint"==typeof t,object:t=>null!==t&&"object"==typeof t,array:t=>Array.isArray(t),function:t=>"function"==typeof t,set:t=>t instanceof Set,map:t=>t instanceof Map,date:t=>t instanceof Date,regexp:t=>t instanceof RegExp},i=(t,e)=>c[t]?.(e)||!1;var s;!function(t){t[t.Local=0]="Local",t[t.Session=1]="Session"}(s||(s={}));class a{constructor(t){this.storage=t===s.Local?localStorage:sessionStorage}getCache(t){const e=this.storage.getItem(t);return e?JSON.parse(e):null}setCache(t,e){this.storage.setItem(t,JSON.stringify(e))}updateCache(t,e,n){const o=this.getCache(t);i("object",o)&&(o[e]=n,this.setCache(t,o))}deleteCache(t){this.storage.removeItem(t)}clearCache(){this.storage.clear()}}const u=new a(s.Local),l=new a(s.Session);function f(t,e=0,n=!1){let o=null,r=!1;function c(...c){return new Promise(((i,s)=>{if(null!==o&&clearTimeout(o),!n||r)o=setTimeout((()=>{try{const e=t.apply(this,c);i(e)}catch(t){s(t)}finally{o=null,r=!1}}),e);else{try{const e=t.apply(this,c);i(e)}catch(t){s(t)}r=!0}}))}return c.cancel=function(){null!==o&&clearTimeout(o),o=null,r=!1},c}function y(t,e,n={}){const{leading:o=!0,trailing:r=!1}=n;let c=0,i=null;function s(...n){return new Promise(((s,a)=>{try{const a=Date.now();let u;o||0!==c||(c=a);const l=e-(a-c);if(l<=0)return i&&clearTimeout(i),u=t.apply(this,n),s(u),c=a,void(i=null);r&&!i&&(i=setTimeout((()=>{u=t.apply(this,n),s(u),c=Date.now(),i=null}),l))}catch(t){a(t)}}))}return s.cancel=function(){i&&clearTimeout(i),c=0,i=null},s}
+function t(t){return function e(...n){return n.length>=t.length?t.apply(this,n):function(...t){return e.apply(this,n.concat(t))}}}function e(...t){const e=t.length;if(!(e<=0)){for(let n=0;n<e;n++){if("function"!=typeof t[n])throw new Error(`argument with index ${n} is not a function`)}return function(...n){let o=0,r=t[o].apply(this,n);for(;++o<e;)r=t[o].call(this,r);return r}}}function n(t,e,n){return t.slice(0,e)+n+t.slice(e)}function o(t,e="",n=""){const o=t.split(e);for(let t=0;t<o.length;t++)o[t]=o[t].slice(0,1).toUpperCase()+o[t].slice(1).toLowerCase();return o.join(n)}const r={string:t=>"string"==typeof t,number:t=>"number"==typeof t,boolean:t=>"boolean"==typeof t,null:t=>null===t,undefined:t=>void 0===t,symbol:t=>"symbol"==typeof t,bigint:t=>"bigint"==typeof t,object:t=>null!==t&&"object"==typeof t,array:t=>Array.isArray(t),function:t=>"function"==typeof t,set:t=>t instanceof Set,map:t=>t instanceof Map,date:t=>t instanceof Date,regexp:t=>t instanceof RegExp},c=(t,e)=>r[t]?.(e)||!1;var i;!function(t){t[t.Local=0]="Local",t[t.Session=1]="Session"}(i||(i={}));class s{constructor(t){this.storage=t===i.Local?localStorage:sessionStorage}getCache(t){const e=this.storage.getItem(t);return e?JSON.parse(e):null}setCache(t,e){this.storage.setItem(t,JSON.stringify(e))}updateCache(t,e,n){const o=this.getCache(t);c("object",o)&&(o[e]=n,this.setCache(t,o))}deleteCache(t){this.storage.removeItem(t)}clearCache(){this.storage.clear()}}const a=new s(i.Local),u=new s(i.Session);function l(t,e=0,n=!1){let o=null,r=!1;function c(...c){return new Promise(((i,s)=>{if(null!==o&&clearTimeout(o),!n||r)o=setTimeout((()=>{try{const e=t.apply(this,c);i(e)}catch(t){s(t)}finally{o=null,r=!1}}),e);else{try{const e=t.apply(this,c);i(e)}catch(t){s(t)}r=!0}}))}return c.cancel=function(){null!==o&&clearTimeout(o),o=null,r=!1},c}function f(t,e,n={}){const{leading:o=!0,trailing:r=!1}=n;let c=0,i=null;function s(...n){return new Promise(((s,a)=>{try{const a=Date.now();let u;o||0!==c||(c=a);const l=e-(a-c);if(l<=0)return i&&clearTimeout(i),u=t.apply(this,n),s(u),c=a,void(i=null);r&&!i&&(i=setTimeout((()=>{u=t.apply(this,n),s(u),c=Date.now(),i=null}),l))}catch(t){a(t)}}))}return s.cancel=function(){i&&clearTimeout(i),c=0,i=null},s}
 //! Function Shallow Copy
-function g(t){return i("array",t)?t.slice():i("object",t)?{...t}:t}
+function y(t){return c("array",t)?t.slice():c("object",t)?{...t}:t}
 //! Function Deep Copy
-const p=t=>i("object",t)||i("function",t);function h(t,e=new WeakMap){if(e.get(t))return e.get(t);const n=function(t,e,n){if(i("symbol",t))return Symbol(t.description);if(!p(t))return t;if(i("set",t)){const o=new Set;return t.forEach((t=>o.add(e(t,n)))),o}if(i("map",t)){const o=new Map;return t.forEach(((t,r)=>o.set(r,e(t,n)))),o}}(t,h,e);if(n)return n;const o=i("array",t),r=o?[]:{};return e.set(t,r),o?t.forEach(((t,n)=>{r[n]=h(t,e)})):(Object.keys(t).forEach((n=>{r[n]=h(t[n],e)})),Object.getOwnPropertySymbols(t).forEach((n=>{r[Symbol(n.description)]=h(t[n],e)}))),r}var m;function S(t,e,n){[t[e],t[n]]=[t[n],t[e]]}function d(t,e,n){return n===m.ASC?t>e:t<e}function w(t,e=m.ASC,n){const o=t.length;if(o<2)return t;for(let r=0;r<o-1;r++)for(let c=0;c<o-1-r;c++){d(n?t[c][n]:t[c],n?t[c+1][n]:t[c+1],e)&&S(t,c,c+1)}return t}!function(t){t.ASC="ASC",t.DESC="DESC"}(m||(m={}));const b=new Map([["yyyy","year"],["MM","month"],["dd","day"],["HH","hours"],["mm","minutes"],["ss","seconds"],["W","week"]]),C=new Map([[1,"一"],[2,"二"],[3,"三"],[4,"四"],[5,"五"],[6,"六"],[0,"日"]]);function M(t){return t.toString().padStart(2,"0")}const D=(t,e="yyyy-MM-dd HH:mm:ss")=>{if(!t)return(new Date).toISOString();const n=function(t){const e=0===t.getDay()?7:t.getDay();return{year:t.getFullYear().toString(),month:M(t.getMonth()+1),day:M(t.getDate()),hours:M(t.getHours()),minutes:M(t.getMinutes()),seconds:M(t.getSeconds()),week:(n=e,C.get(n)||""),weekNum:e.toString()};var n}(new Date(t));if(i("string",e)&&!e.trim())return n;return Array.from(b).reduce(((t,[e,o])=>t.replace(new RegExp(e,"g"),n[o])),e)};export{w as bubblingSort,e as compose,t as currying,f as debounce,h as deepClone,D as formatTimer,n as insertStr,i as isType,u as localCache,l as sessionCache,r as setTimer,g as shallowClone,o as stringCase,y as throttle};
+const g=t=>c("object",t)||c("function",t);function p(t,e=new WeakMap){if(e.get(t))return e.get(t);const n=function(t,e,n){if(c("symbol",t))return Symbol(t.description);if(!g(t))return t;if(c("set",t)){const o=new Set;return t.forEach((t=>o.add(e(t,n)))),o}if(c("map",t)){const o=new Map;return t.forEach(((t,r)=>o.set(r,e(t,n)))),o}}(t,p,e);if(n)return n;const o=c("array",t),r=o?[]:{};return e.set(t,r),o?t.forEach(((t,n)=>{r[n]=p(t,e)})):(Object.keys(t).forEach((n=>{r[n]=p(t[n],e)})),Object.getOwnPropertySymbols(t).forEach((n=>{r[Symbol(n.description)]=p(t[n],e)}))),r}var h;function m(t,e,n){[t[e],t[n]]=[t[n],t[e]]}function S(t,e,n){return n===h.ASC?t>e:t<e}function d(t,e=h.ASC,n){const o=t.length;if(o<2)return t;for(let r=0;r<o-1;r++)for(let c=0;c<o-1-r;c++){S(n?t[c][n]:t[c],n?t[c+1][n]:t[c+1],e)&&m(t,c,c+1)}return t}!function(t){t.ASC="ASC",t.DESC="DESC"}(h||(h={}));const w=new Map([["yyyy","year"],["MM","month"],["dd","day"],["HH","hours"],["mm","minutes"],["ss","seconds"],["W","week"]]),b=new Map([[1,"一"],[2,"二"],[3,"三"],[4,"四"],[5,"五"],[6,"六"],[0,"日"]]);function C(t){return t.toString().padStart(2,"0")}const M=(t,e="yyyy-MM-dd HH:mm:ss")=>{if(!t)return(new Date).toISOString();const n=function(t){const e=0===t.getDay()?7:t.getDay();return{year:t.getFullYear().toString(),month:C(t.getMonth()+1),day:C(t.getDate()),hours:C(t.getHours()),minutes:C(t.getMinutes()),seconds:C(t.getSeconds()),week:(n=e,b.get(n)||""),weekNum:e.toString()};var n}(new Date(t));if(c("string",e)&&!e.trim())return n;return Array.from(w).reduce(((t,[e,o])=>t.replace(new RegExp(e,"g"),n[o])),e)};function D(t,e=0,n=!1){let o=null;const r=()=>{t(),o=setTimeout(r,e)};return n&&t(),setTimeout(r,e),{cancel:()=>{null!==o&&clearTimeout(o)}}}export{d as bubblingSort,e as compose,t as currying,l as debounce,p as deepClone,M as formatTimer,n as insertStr,c as isType,a as localCache,u as sessionCache,D as setTimer,y as shallowClone,o as stringCase,f as throttle};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "devix",
   "type": "module",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Devix is a comprehensive, powerful, and compact JavaScript utility library.",
   "author": "king-3 <w2196592083@gmail.com>",
   "license": "MIT",