easy-soft-utility 2.4.102 → 2.4.103

package/es/utils/messagePromptAssist.d.ts

@@ -3,7 +3,7 @@ export function checkMessagePromptData({ text }: {
 }): boolean;
 /**
  * Set duration conversion ratio
- * @param {Number} ratio conversion ratio
+ * @param {number} ratio conversion ratio
  */
 export function setDurationConversionRatio(ratio: number): void;
 /**
@@ -43,14 +43,14 @@ export function setWarningMessageDisplayMonitor(callbackMonitor: Function): void
 export function setErrorMessageDisplayMonitor(callbackMonitor: Function): void;
 /**
  * Show simple text open message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleOpenMessage(text: string): void;
 /**
  * Show open message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showOpenMessage({ text, duration, onClose }: {
@@ -60,14 +60,14 @@ export function showOpenMessage({ text, duration, onClose }: {
 }): void;
 /**
  * Show simple text loading message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleLoadingMessage(text: string): void;
 /**
  * Show loading message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showLoadingMessage({ text, duration, onClose, }: {
@@ -77,14 +77,14 @@ export function showLoadingMessage({ text, duration, onClose, }: {
 }): void;
 /**
  * Show simple text info message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleInfoMessage(text: string): void;
 /**
  * Show info message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showInfoMessage({ text, duration, onClose }: {
@@ -94,14 +94,14 @@ export function showInfoMessage({ text, duration, onClose }: {
 }): void;
 /**
  * Show simple text success message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleSuccessMessage(text: string): void;
 /**
  * Show success message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showSuccessMessage({ text, duration, onClose, }: {
@@ -111,14 +111,14 @@ export function showSuccessMessage({ text, duration, onClose, }: {
 }): void;
 /**
  * Show simple text warn message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleWarnMessage(text: string): void;
 /**
  * Show warn message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showWarnMessage({ text, duration, onClose }: {
@@ -128,14 +128,14 @@ export function showWarnMessage({ text, duration, onClose }: {
 }): void;
 /**
  * Show simple text warning message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleWarningMessage(text: string): void;
 /**
  * Show warning message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showWarningMessage({ text, duration, onClose, }: {
@@ -145,14 +145,14 @@ export function showWarningMessage({ text, duration, onClose, }: {
 }): void;
 /**
  * Show simple text error message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleErrorMessage(text: string): void;
 /**
  * Show error message with display monitor
  * @param {Object} option message option
- * @param {String} option.text message text
- * @param {Number} option.duration message duration time, default is 1500
+ * @param {string} option.text message text
+ * @param {number} option.duration message duration time, default is 1500
  * @param {Function} option.onClose onClose callback
  */
 export function showErrorMessage({ text, duration, onClose, }: {
@@ -162,7 +162,7 @@ export function showErrorMessage({ text, duration, onClose, }: {
 }): void;
 /**
  * Show simple runtime error message with display monitor
- * @param {String} text simple text message
+ * @param {string} text simple text message
  */
 export function showSimpleRuntimeError(text: string): void;
 /**

package/es/utils/meta.d.ts

@@ -1,8 +1,8 @@
 /**
  * Calculate the value of the expression
- * @param {Function} fn
+ * @param {Function} functionExpression
  */
-export function evil(function_: any): any;
+export function evil(functionExpression: Function): any;
 export function isBrowser(): boolean;
 /**
  * check current is dark mode

package/es/utils/modelAssist.d.ts

@@ -18,7 +18,6 @@ export function appendExtraBuilder(builder: Function): void;
 export function buildModelCollection(): void;
 /**
  * Get model collection.
- * @returns
  */
 export function getModelCollection(): never[];
 /**
@@ -27,8 +26,7 @@ export function getModelCollection(): never[];
 export function getModelNameList(): void;
 /**
  * Set model name list.
- * @param {String} modelNameList model name list, eg like "article,product,news"
- * @returns
+ * @param {string} modelNameList model name list, eg like "article,product,news"
  */
 export function setModelNameList(modelNameList: string): void;
 /**

package/es/utils/parametersDataAssist.d.ts

@@ -1,24 +1,16 @@
 /**
- * 移除信息
- *
- * @export
- * @param {*} fn
- * @returns
+ * Remove parameters data cache
+ * @param {string} key the cache key
  */
-export function removeParametersDataCache(key: any): void;
+export function removeParametersDataCache(key: string): void;
 /**
- * 获取useParamsData缓存
- *
- * @export
- * @param {*} fn
- * @returns
+ * Get parameters data cache
+ * @param {string} key the cache key
  */
-export function getParametersDataCache(key: any): any;
+export function getParametersDataCache(key: string): any;
 /**
- * 设置useParamsData缓存
- *
- * @export
- * @param {o} useParamsData数据
- * @returns
+ * Set parameters data cache
+ * @param {string} key the cache key
+ * @param {Object} data the data will be cached
  */
-export function setParametersDataCache(key: any, o: any): void;
+export function setParametersDataCache(key: string, data: Object): void;

package/es/utils/requestAssist.d.ts

@@ -1,21 +1,21 @@
 /**
  * Set request success code
- * @param {Number} code success code
+ * @param {number} code success code
  */
 export function setSuccessCode(code: number): void;
 /**
  * Set request authentication fail code
- * @param {Number} code authentication fail code
+ * @param {number} code authentication fail code
  */
 export function setAuthenticationFailCode(code: number): void;
 /**
  * Set prompt simulative request
- * @param {Boolean} value whether prompt simulative request
+ * @param {boolean} value whether prompt simulative request
  */
 export function setPromptSimulation(value: boolean): void;
 /**
  * Set the url global prefix
- * @param {String} globalPrefix url global prefix, eg "V1" like api version
+ * @param {string} globalPrefix url global prefix, eg "V1" like api version
  */
 export function setUrlGlobalPrefix(globalPrefix: string): void;
 /**
@@ -35,61 +35,93 @@ export function setAuthenticationFailHandler(handler: Function): void;
 export function setGlobalHeaderSupplementHandler(handler: Function): void;
 /**
  * Set request info display switch
- * @param {Boolean} value display switch
+ * @param {boolean} value display switch
  */
 export function setRequestInfoDisplaySwitch(value: boolean): void;
 /**
- * 预处理单项数据返回
- *
- * @export
- * @param {*} source 源数据
- * @param {*} pretreatment 源数据预处理
- * @param {*} successCallback 请求成功后的可回调函数
- * @param {*} failCallback 请求失败后的可回调函数
- * @returns
- */
-export function pretreatmentRemoteSingleData({ source, pretreatment, successCallback, failCallback, }: any): {};
-/**
- * 预处理集合数据返回
- *
- * @export
- * @param {*} source
- * @param {*} pretreatment 源数据预处理
- * @param {*} itemPretreatment 源数据项预处理
- * @param {*} successCallback 请求成功后的可回调函数
- * @param {*} failCallback 请求失败后的可回调函数
- * @returns
- */
-export function pretreatmentRemoteListData({ source, pretreatment, itemPretreatment, successCallback, failCallback, }: any): {};
-/**
- * 预处理分页数据返回
- *
- * @export
- * @param {*} source
- * @param {*} pretreatment 源数据预处理
- * @param {*} itemPretreatment 源数据项预处理
- * @param {*} successCallback 请求成功后的可回调函数
- * @param {*} failCallback 请求失败后的可回调函数
- * @returns
- */
-export function pretreatmentRemotePageListData({ source, pretreatment, itemPretreatment, successCallback, failCallback, }: any): {};
-/**
- * 预处理数据请求
- *
- * @export
- * @param {*} d
- * @returns
- */
-export function pretreatmentRequestParameters(parameters: any, customHandle: any): any;
-/**
- * handleListDataAssist
- * @param {*} state
- * @param {*} action
- * @param {*} pretreatment
- * @param {*} callback
- * @returns
- */
-export function handleListDataAssist(state: any, action: any, namespace: any): any;
+ * Pretreatment remote object data
+ * @param {Object} options request options
+ * @param {Object} options.source source object data
+ * @param {Function|null} options.pretreatment pretreatment source object data
+ * @param {Function|null} options.successCallback success callback handler
+ * @param {Function|null} options.failCallback fail callback handler
+ */
+export function pretreatmentRemoteSingleData({ source, pretreatment, successCallback, failCallback, }: {
+    source: Object;
+    pretreatment: Function | null;
+    successCallback: Function | null;
+    failCallback: Function | null;
+}): {};
+/**
+ * Pretreatment remote list data
+ * @param {Object} options handler options
+ * @param {Array} options.source source list data
+ * @param {Function|null} options.pretreatment pretreatment source list data
+ * @param {Function|null} options.itemPretreatment pretreatment source list data item
+ * @param {Function|null} options.successCallback success callback handler
+ * @param {Function|null} options.failCallback fail callback handler
+ */
+export function pretreatmentRemoteListData({ source, pretreatment, itemPretreatment, successCallback, failCallback, }: {
+    source: any[];
+    pretreatment: Function | null;
+    itemPretreatment: Function | null;
+    successCallback: Function | null;
+    failCallback: Function | null;
+}): {};
+/**
+ * Pretreatment remote page list data
+ * @param {Object} options handler options
+ * @param {Array} options.source source page list data
+ * @param {Function|null} options.pretreatment pretreatment source page list data
+ * @param {Function|null} options.itemPretreatment pretreatment source page list data item
+ * @param {Function|null} options.successCallback success callback handler
+ * @param {Function|null} options.failCallback fail callback handler
+ */
+export function pretreatmentRemotePageListData({ source, pretreatment, itemPretreatment, successCallback, failCallback, }: {
+    source: any[];
+    pretreatment: Function | null;
+    itemPretreatment: Function | null;
+    successCallback: Function | null;
+    failCallback: Function | null;
+}): {};
+/**
+ * Pretreatment request parameters
+ * @param {Object} parameters the parameters will pretreatment
+ * @param {Function} customHandle custom handler
+ */
+export function pretreatmentRequestParameters(parameters: Object, customHandle: Function): {
+    constructor: Function;
+    toString(): string;
+    toLocaleString(): string;
+    valueOf(): Object;
+    hasOwnProperty(v: PropertyKey): boolean;
+    isPrototypeOf(v: Object): boolean;
+    propertyIsEnumerable(v: PropertyKey): boolean;
+};
+/**
+ * handle list data assist
+ * @param {Object} state state
+ * @param {Object} action action
+ * @param {string} namespace model namespace
+ */
+export function handleListDataAssist(state: Object, action: Object, namespace: string): {
+    data: {};
+    constructor: Function;
+    toString(): string;
+    toLocaleString(): string;
+    valueOf(): Object;
+    hasOwnProperty(v: PropertyKey): boolean;
+    isPrototypeOf(v: Object): boolean;
+    propertyIsEnumerable(v: PropertyKey): boolean;
+} | {
+    constructor: Function;
+    toString(): string;
+    toLocaleString(): string;
+    valueOf(): Object;
+    hasOwnProperty(v: PropertyKey): boolean;
+    isPrototypeOf(v: Object): boolean;
+    propertyIsEnumerable(v: PropertyKey): boolean;
+};
 export function handlePageListDataAssist(state: any, action: any, namespace: any): any;
 /**
  * Begin request（remote request / local simulate requests）
@@ -97,15 +129,15 @@ export function handlePageListDataAssist(state: any, action: any, namespace: any
  * @param {string} option.api request address
  * @param {Object} option.params request params
  * @param {Object} option.header request header
- * @param {String} option.method "GET"/"POST"/"PUT"/"DELETE", default is requestMethod.post
- * @param {String} option.mode request mode, default is requestMode.real
- * @param {Boolean} option.promptSimulation whether display simulate request message prompt
- * @param {Number} option.promptSimulationDelay display simulate request message prompt delay time, default is 500
- * @param {Number} option.simulateRequestDelay simulate request delay time, default is 0
+ * @param {string} option.method "GET"/"POST"/"PUT"/"DELETE", default is requestMethod.post
+ * @param {string} option.mode request mode, default is requestMode.real
+ * @param {boolean} option.promptSimulation whether display simulate request message prompt
+ * @param {number} option.promptSimulationDelay display simulate request message prompt delay time, default is 500
+ * @param {number} option.simulateRequestDelay simulate request delay time, default is 0
  * @param {Object} option.simulativeSuccessResponse simulate request success response
  * @param {Object} option.simulativeFailResponse simulate request fail response
- * @param {Boolean} option.simulateRequestResult specifies whether the result is successful, generally used to debug
- * @param {Boolean} option.simulativeAuthorize set simulate request whether check token, only check mull or empty, generally used to debug
+ * @param {boolean} option.simulateRequestResult specifies whether the result is successful, generally used to debug
+ * @param {boolean} option.simulativeAuthorize set simulate request whether check token, only check mull or empty, generally used to debug
  */
 export function request({ api, urlParams: urlParameters, params: parameters, header, method, mode, promptSimulation, promptSimulationDelay, simulateRequestDelay, simulativeSuccessResponse, simulativeFailResponse, simulateRequestResult, simulativeAuthorize, }: {
     api: string;

package/es/utils/sessionStorageAssist.d.ts

@@ -1,43 +1,52 @@
 /**
  * Set session storage getter
+ * @param {Function} handler the cache getter handler
  */
-export function setSessionStorageGetter(handler: any): void;
+export function setSessionStorageGetter(handler: Function): void;
 /**
  * Set session storage setter
+ * @param {Function} handler the cache setter handler
  */
-export function setSessionStorageSetter(handler: any): void;
+export function setSessionStorageSetter(handler: Function): void;
 /**
  * Set session storage remover
+ * @param {Function} handler the cache remover handler
  */
-export function setSessionStorageRemover(handler: any): void;
+export function setSessionStorageRemover(handler: Function): void;
 /**
  * Set session storage remover
+ * @param {Function} handler the cache flusher handler
  */
-export function setSessionStorageFlusher(handler: any): void;
+export function setSessionStorageFlusher(handler: Function): void;
 /**
  * Get text to session storage with key
+ * @param {string} key the cache key
  */
-export function getStringFromSessionStorage(key: any): void;
+export function getStringFromSessionStorage(key: string): void;
 /**
  * Get json to session storage with key
+ * @param {string} key the cache key
  */
-export function getJsonFromSessionStorage(key: any): any;
+export function getJsonFromSessionStorage(key: string): any;
 /**
  * Save text to session storage with key
+ * @param {string} key the cache key
+ * @param {string} text the test will be cached
  */
-export function saveStringToSessionStorage(key: any, text: any): void;
+export function saveStringToSessionStorage(key: string, text: string): void;
 /**
  * Save json to session storage with key
+ * @param {string} key the cache key
+ * @param {Object} data the data will be cached
  */
-export function saveJsonToSessionStorage(key: any, json: any): void;
+export function saveJsonToSessionStorage(key: string, data: Object): void;
 /**
  * Remove session storage by key
+ * @param {string} key the cache key
  */
-export function removeSessionStorage(key: any): void;
+export function removeSessionStorage(key: string): void;
 /**
  * Flush session storage
- * @export
- * @param {*} key
  */
 export function flushSessionStorage(): void;
 export namespace sessionStorageAssist {

package/es/utils/tokenAssist.d.ts

@@ -8,16 +8,11 @@ export function getTokenKeyName(): string;
 export function getToken(): void;
 /**
  * Set token catch
- * @param {String} value
- * @returns
+ * @param {string} value
  */
 export function setToken(value: string): void;
 /**
  * Remove token catch
- *
- * @export
- * @param {*} fn
- * @returns
  */
 export function removeToken(): void;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-soft-utility",
-  "version": "2.4.102",
+  "version": "2.4.103",
   "private": false,
   "description": "easy-soft-utility",
   "keywords": [
@@ -29,9 +29,8 @@
     "build:rollup:skipCompression": "npx rimraf ./es && rollup --config rollup.config.skipCompression.js --bundleConfigAsCjs",
     "postbuild:rollup:skipCompression": "npm run z:tsc:build",
     "dev:rollup": "rollup --config rollup.config.skipCompression.js --bundleConfigAsCjs --watch --watch.onBundleEnd=\"npm run z:tsc:build\"",
-    "pregenerate:documentation": "npx rimraf ./docs && documentation lint src/**",
-    "generate:documentation": "npx documentation build src/** -f html --github -o docs",
     "precommit": "npm run z:lint:staged:quiet",
+    "z:auto:adjust:file": "npm run z:documentation:generate",
     "prez:documentation:generate": "npx rimraf ./docs && npm run z:documentation:lint",
     "z:documentation:generate": "npx documentation build src/** -f html --github -o docs",
     "z:documentation:lint": "npx documentation lint src/**",
@@ -114,7 +113,7 @@
     "cross-env": "^7.0.3",
     "cssnano": "^5.1.15",
     "documentation": "^14.0.1",
-    "easy-soft-develop": "^2.0.191",
+    "easy-soft-develop": "^2.0.195",
     "eslint": "^8.36.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
@@ -144,7 +143,7 @@
     "qs": "^6.11.1",
     "react-refresh": "^0.14.0",
     "rimraf": "^4.4.1",
-    "rollup": "^3.20.0",
+    "rollup": "^3.20.1",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-livereload": "^2.0.5",
     "rollup-plugin-postcss": "^4.0.2",