easy-soft-utility 2.4.102 → 2.4.103

package/es/utils/checkAssist.d.ts

@@ -111,13 +111,11 @@ export function isWeekend(date: Date): boolean;
 /**
  * check date in the year
  * @param {Date} date the datetime will check
- * @param {string|Number} year year
- * @returns
+ * @param {string|number} year year
  */
 export function inYear(date: Date, year: string | number): boolean;
 /**
  * Check target is async function
  * @param {*} f the function will check
- * @returns
  */
 export function isAsyncFunction(f: any): boolean;

package/es/utils/colorAssist.d.ts

@@ -1,9 +1,6 @@
 /**
  * Build random hex color through configuration such as seeds
- *
- * @export
  * @param {*} seed
- * @returns
  */
 export function buildRandomHexColor({ seed }: any): string;
 /**
@@ -16,7 +13,6 @@ export function buildRGBColorFromHexColor(color: any, symbol?: any, arrayMode?:
 /**
  * Build hex color like '#E564F2'
  * @param {*} param0
- * @returns
  */
 export function buildHexColor({ progress, startColor, endColor }: any): string;
 /**

package/es/utils/common.d.ts

@@ -16,16 +16,14 @@ export function sleep(n: any, callback: any): void;
 export function getPathValue(o: any, path: any, defaultValue?: null): any;
 /**
  * Remove end match string
- * @param {String} target the string to be retrieved
- * @param {String} match matching specification
- * @returns
+ * @param {string} target the string to be retrieved
+ * @param {string} match matching specification
  */
 export function removeEndMatch(target: string, match: string): string;
 /**
  * Remove last match string
- * @param {String} target the string to be retrieved
- * @param {String} match matching specification
- * @returns
+ * @param {string} target the string to be retrieved
+ * @param {string} match matching specification
  */
 export function removeLastMatch(target: string, match: string): string;
 /**
@@ -70,18 +68,16 @@ export function transformData({ data, convert, recursiveKey, }: {
  * check exist in array
  * @param {Array} array the array will be seek
  * @param {Function} predicateFunction predicate function
- * @param {Number} fromIndex from index position, default is 0
- * @returns
+ * @param {number} fromIndex from index position, default is 0
  */
 export function checkExist(array: any[], predicateFunction: Function, fromIndex?: number): boolean;
 /**
  * 处理已存储的远程接口列表数据中的指定键数据
  * @param {Object} options 配置参数
  * @param {Object} options.target 目标调用对象, 需要具备 state 以及 setState
- * @param {String} options.value 目标对比值
+ * @param {string} options.value 目标对比值
  * @param {Function} options.compareValueHandler 解析处列表项键值数据进行对比, 需返回待对比数据
  * @param {Function} options.handler 处理对比命中的项的函数, 处理结果将被替换进列表
- * @returns
  */
 export function handleItem({ target, value, compareValueHandler, handler }: {
     target: Object;

package/es/utils/componentAssist.d.ts

@@ -5,13 +5,13 @@
 export function mergeProperties(...items: any): any;
 /**
  * Build style data to string
- * @param {Object|String} style the style will be builded
+ * @param {Object|string} style the style will be builded
  */
 export function buildStringStyle(style: Object | string): string;
 /**
  * Merge style
- * @param {Object|String} target the target style will be merged
- * @param {Object|String} style the other style will be merged
+ * @param {Object|string} target the target style will be merged
+ * @param {Object|string} style the other style will be merged
  */
 export function mergeStyle(target: Object | string, style: Object | string): string | Object;
 export function attachPropertiesToComponent(component: any, properties: any): any;

package/es/utils/constants.d.ts

@@ -15,44 +15,44 @@ export namespace accessWaySpecialCollection {
     export { _super as super };
 }
 export namespace environmentCollection {
-    const WEAPP: string;
-    const WEB: string;
+    const ALIPAY: string;
+    const JD: string;
+    const QQ: string;
     const RN: string;
     const SWAN: string;
-    const ALIPAY: string;
     const TT: string;
-    const QQ: string;
-    const JD: string;
     const UNKNOWN: string;
+    const WEAPP: string;
+    const WEB: string;
 }
 export namespace alignHorizontal {
+    const center: string;
     const left: string;
     const right: string;
-    const center: string;
 }
 export namespace alignVertical {
-    const top: string;
-    const middle: string;
     const bottom: string;
+    const middle: string;
+    const top: string;
 }
 export namespace underlyingState {
-    const loadApiPath: string;
-    const firstLoadSuccess: boolean;
-    const loadSuccess: boolean;
-    const registering: boolean;
     const dataLoading: boolean;
-    const reloading: boolean;
-    const searching: boolean;
-    const refreshing: boolean;
-    const paging: boolean;
-    const processing: boolean;
     const dispatchComplete: boolean;
+    const externalData: null;
+    const firstLoadSuccess: boolean;
+    const loadApiPath: string;
+    const loadSuccess: boolean;
     const metaData: null;
     const metaExtra: null;
     const metaListData: never[];
     const metaOriginalData: null;
+    const paging: boolean;
+    const processing: boolean;
+    const refreshing: boolean;
+    const registering: boolean;
+    const reloading: boolean;
+    const searching: boolean;
     const urlParams: null;
-    const externalData: null;
 }
 export namespace underlyingExtensionState {
     const dataLoading_1: boolean;

package/es/utils/convertAssist.d.ts

@@ -21,6 +21,7 @@ export function toMoney(target: any): number;
 export function toPercentage(value: any): string;
 /**
  * Convert to string
+ * @param {*} target
  */
 export function toString(target: any): string;
 /**
@@ -33,14 +34,20 @@ export function toBoolean(target: any): boolean;
 export function toUpper(target: any): string;
 export function toUpperFirst(source: any): string;
 /**
- * Convert to lower
+ * Convert to lower string
+ * @param {string|null} target
  */
-export function toLower(target: any): string;
-export function toLowerFirst(target: any): string;
+export function toLower(target: string | null): string;
+/**
+ * Convert to lower first string
+ * @param {string|null} target
+ */
+export function toLowerFirst(target: string | null): string;
 /**
  * Convert to datetime
+ * @param {Date|string|number} target
  */
-export function toDatetime(target: any): any;
+export function toDatetime(target: Date | string | number): Date;
 /**
  * Convert to Promise
  */

package/es/utils/datetime.d.ts

@@ -1,18 +1,54 @@
 /**
  * create dayjs datetime
- * @param {String} datetime a datetime string, eg "2020-01-02"
- * @param {String} format format string, eg "YYYY-MM-DD"
- * @returns
+ * @param {string} datetime a datetime string, eg "2020-01-02"
+ * @param {string} format format string, eg "YYYY-MM-DD"
  */
 export function createDayJsDatetime(datetime: string, format: string): dayjs.Dayjs;
-export function addHour(datetime: any, value: any): any;
-export function addMinute(datetime: any, value: any): any;
-export function addSecond(datetime: any, value: any): any;
+/**
+ * Add hour to target time
+ * @param {Date|string} datetime target time
+ * @param {number} value
+ */
+export function addHour(datetime: Date | string, value: number): Date;
+/**
+ * Add minute to target time
+ * @param {Date|string} datetime target time
+ * @param {number} value
+ */
+export function addMinute(datetime: Date | string, value: number): Date;
+/**
+ * Add second to target time
+ * @param {Date|string} datetime target time
+ * @param {number} value
+ */
+export function addSecond(datetime: Date | string, value: number): Date;
+/**
+ * Get current time
+ */
 export function getNow(): Date;
+/**
+ * Compare time less than target
+ * @param {Date|number|string} time the time will compare.
+ * @param {Date|number|string} compareTarget compare target.
+ */
+export function compareTimeLessThan(time: Date | number | string, compareTarget: Date | number | string): boolean;
+/**
+ * Compare time greater than target
+ * @param {Date|number|string} time the time will compare.
+ * @param {Date|number|string} compareTarget compare target.
+ */
+export function compareTimeGreaterThan(time: Date | number | string, compareTarget: Date | number | string): boolean;
+/**
+ * get time stamp
+ * @param {Date|string|number|null} time time, if time is null, will use now time.
+ */
+export function getTimeStamp(time?: Date | string | number | null): number;
 /**
  * Calculate time interval
+ * @param {Date} startTime start time.
+ * @param {Date} endTime end time.
  */
-export function calculateTimeInterval(startTime: any, endTime: any): {
+export function calculateTimeInterval(startTime: Date, endTime: Date): {
     day: number;
     hour: number;
     minute: number;
@@ -25,6 +61,6 @@ export function getDayOfWeek({ data: date }: {
  * Get today in week like '星期日' / '星期一' / '星期二' / '星期三' / '星期四' / '星期五' / '星期六'
  */
 export function getTodayOfWeek(transferChinese?: boolean): string | number;
-export function calculateDateInterval(date: any, nowDate: any, unit: any): number;
+export function calculateDateInterval(date: Date | number | string, nowDate: Date | number | string | null, unit: string | null): number;
 export function calculateMonthInterval(startMonth: any, endMonth: any): number;
 import dayjs from "dayjs";

package/es/utils/formatAssist.d.ts

@@ -38,8 +38,7 @@ export function formatTarget({ target, format, option }: {
 export function formatDateInterval(startTime: any, endTime: any, options?: {}): any;
 /**
  * 格式化指定时间与当前时间的时间间隔
- * @param    {time} start 时间
- * @param    {Object} opts 配置参数
- * @return   {String}      文本内容
+ * @param {Date} time 时间
+ * @param {Object} options 配置参数
  */
-export function formatDateIntervalWithNow(time: any, options?: {}): string;
+export function formatDateIntervalWithNow(time: Date, options?: Object): any;

package/es/utils/localMetaDataAssist.d.ts

@@ -1,24 +1,13 @@
 /**
- * 获取元数据
- *
- * @export
- * @param {*} fn
- * @returns
+ * Get local meta data
  */
 export function getLocalMetaData(): any;
 /**
- * 设置元数据
- *
- * @export
- * @param {*} fn
- * @returns
+ * Set local meta data
+ * @param {Object} data the date will save to local storage.
  */
-export function setLocalMetaData(data: any): void;
+export function setLocalMetaData(data: Object): void;
 /**
- * 移除元数据
- *
- * @export
- * @param {*} fn
- * @returns
+ * Remove local meta data
  */
 export function removeLocalMetaData(): void;

package/es/utils/localStorageAssist.d.ts

@@ -1,43 +1,52 @@
 /**
  * Set local storage getter
+ * @param {Function} handler the cache getter handler
  */
-export function setLocalStorageGetter(handler: any): void;
+export function setLocalStorageGetter(handler: Function): void;
 /**
  * Set local storage setter
+ * @param {Function} handler the cache setter handler
  */
-export function setLocalStorageSetter(handler: any): void;
+export function setLocalStorageSetter(handler: Function): void;
 /**
  * Set local storage remover
+ * @param {Function} handler the cache remover handler
  */
-export function setLocalStorageRemover(handler: any): void;
+export function setLocalStorageRemover(handler: Function): void;
 /**
  * Set local storage remover
+ * @param {Function} handler the cache flusher handler
  */
-export function setLocalStorageFlusher(handler: any): void;
+export function setLocalStorageFlusher(handler: Function): void;
 /**
  * Get text to local storage with key
+ * @param {string} key the cache key
  */
-export function getStringFromLocalStorage(key: any): void;
+export function getStringFromLocalStorage(key: string): void;
 /**
  * Get json to local storage with key
+ * @param {string} key the cache key
  */
-export function getJsonFromLocalStorage(key: any): any;
+export function getJsonFromLocalStorage(key: string): any;
 /**
  * Save text to local storage with key
+ * @param {string} key the cache key
+ * @param {string} text the data will cache
  */
-export function saveStringToLocalStorage(key: any, text: any): void;
+export function saveStringToLocalStorage(key: string, text: string): void;
 /**
  * Save json to local storage with key
+ * @param {string} key the cache key
+ * @param {Object} json the data will cache
  */
-export function saveJsonToLocalStorage(key: any, json: any): void;
+export function saveJsonToLocalStorage(key: string, json: Object): void;
 /**
  * Remove local storage by key
+ * @param {string} key the cache key
  */
-export function removeLocalStorage(key: any): void;
+export function removeLocalStorage(key: string): void;
 /**
  * Flush local storage
- * @export
- * @param {*} key
  */
 export function flushLocalStorage(): void;
 export namespace localStorageAssist {

package/es/utils/lodashTools.d.ts

@@ -47,41 +47,41 @@ export function size(collection: any): number;
 export function difference(array: any, values: any): any[];
 /**
  * 筛选需要的集合
- * @param {collection} 可筛选的对象, 例如数组
- * @param {predicateFunction} 每次迭代调用的筛选函数
+ * @param {Array} collection 可筛选的对象, 例如数组
+ * @param {Function} predicateFunction 每次迭代调用的筛选函数
  */
-export function filter(collection: any, predicateFunction: any): string[];
+export function filter(collection: any[], predicateFunction: Function): any[];
 /**
  * 创建一个元素数组.  以 iteratee 处理的结果升序排序.  这个方法执行稳定排序, 也就是说相同元素会保持原始排序.  iteratees 调用1个参数:  (value).
- * @param {collection}  (Array|Object), 用来迭代的集合.
- * @param {predicateFunction} 这个函数决定排序
+ * @param {Array} collection 用来迭代的集合.
+ * @param {Function} predicateFunction 这个函数决定排序
  */
-export function sortBy(collection: any, predicateFunction: any): any[];
+export function sortBy(collection: any[], predicateFunction: Function): any[];
 /**
  * 该方法返回第一个通过 predicateFunction 判断为真值的元素的索引值（index）, 而不是元素本身.
- * @param {array} (Array): 要搜索的数组.
- * @param {predicateFunction} 这个函数会在每一次迭代调用
- * @param {fromIndex} (number): The index to search from.
+ * @param {Array} array 要搜索的数组.
+ * @param {Function} predicateFunction 这个函数会在每一次迭代调用
+ * @param {number} fromIndex the index to search from.
  */
-export function findIndex(array: any, predicateFunction: any, fromIndex?: number): number;
+export function findIndex(array: any[], predicateFunction: Function, fromIndex?: number): number;
 /**
  * 该方法返回第一个通过 predicateFunction 判断为真值的元素的索引值（index）, 而不是元素本身,返回匹配元素, 否则返回 undefined. .
- * @param {array} (Array): 要搜索的数组.
- * @param {predicateFunction} 这个函数会在每一次迭代调用
- * @param {fromIndex} (number): The index to search from.
+ * @param {Array} array 要搜索的数组.
+ * @param {Function} predicateFunction 这个函数会在每一次迭代调用
+ * @param {number} fromIndex the index to search from.
  */
-export function find(array: any, predicateFunction: any, fromIndex?: number): any;
+export function find(array: any[], predicateFunction: Function, fromIndex?: number): any;
 /**
  * debounce a function
- * @param {Function} f
- * @param {Number} wait
+ * @param {Function} functionCall
+ * @param {number} wait
  * @param {Object} options
  */
-export function debounce(f: Function, wait?: number, options?: Object): void;
+export function debounce(functionCall: Function, wait?: number, options?: Object): void;
 /**
  * throttle a function
- * @param {Function} f
- * @param {Number} wait
+ * @param {Function} functionCall
+ * @param {number} wait
  * @param {Object} options
  */
-export function throttle(f: Function, wait?: number, options?: Object): void;
+export function throttle(functionCall: Function, wait?: number, options?: Object): void;

package/es/utils/loggerAssist.d.ts

@@ -1,16 +1,16 @@
 /**
  * Merge text message
- * @param {String} text the string will be merged
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be merged
+ * @param {string} text the string will be merged
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be merged
  */
 export function mergeTextMessage(text: string, ancillaryInformation: string): string;
 /**
  * Display text message
  * @param {Object} option log option
- * @param {String} option.text the string will be display
- * @param {String} option.color use this color to display
- * @param {String} option.dataDescription log prefix, when it not empty, it will be display
- * @param {String} option.ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string} option.text the string will be display
+ * @param {string} option.color use this color to display
+ * @param {string} option.dataDescription log prefix, when it not empty, it will be display
+ * @param {string} option.ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function displayTextMessage({ text, color, dataDescription, ancillaryInformation, }: {
     text: string;
@@ -21,10 +21,10 @@ export function displayTextMessage({ text, color, dataDescription, ancillaryInfo
 /**
  * Display object message
  * @param {Object} option log option
- * @param {String} option.data the string will be display
- * @param {String} option.color use this color to display
- * @param {String} option.dataDescription log prefix, when it not empty, it will be display
- * @param {String} option.ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string} option.data the string will be display
+ * @param {string} option.color use this color to display
+ * @param {string} option.dataDescription log prefix, when it not empty, it will be display
+ * @param {string} option.ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function displayObjectMessage({ data, color, dataDescription, ancillaryInformation, }: {
     data: string;
@@ -34,84 +34,84 @@ export function displayObjectMessage({ data, color, dataDescription, ancillaryIn
 }): void;
 /**
  * Log data message, default displayMode is logDisplay.auto, default level is logLevel.debug, default ancillaryInformation is empty string
- * @param {String} data the data will be display
- * @param {String} displayMode display mode, use logDisplay enum
- * @param {String} level log level, use logLevel enum
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string} data the data will be display
+ * @param {string} displayMode display mode, use logDisplay enum
+ * @param {string} level log level, use logLevel enum
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logData(data: string, displayMode?: string, level?: string, ancillaryInformation?: string): void;
 /**
  * Log warn message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logWarn(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log info message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logInfo(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log config message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logConfig(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log development environment message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logDevelop(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log stack message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logStack(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log trace message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logTrace(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log debug message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logDebug(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log execute message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logExecute(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log error message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logError(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log error message, default ancillaryInformation is empty string
- * @param {String|Object} data the data will be display
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string|Object} data the data will be display
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logException(data: string | Object, ancillaryInformation?: string): void;
 /**
  * Log text message, default level is logLevel.trace, default ancillaryInformation is empty string
- * @param {String} text the text will be display
- * @param {String} level log level, use logLevel enum
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string} text the text will be display
+ * @param {string} level log level, use logLevel enum
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logText(text: string, level?: string, ancillaryInformation?: string): void;
 /**
  * Log object message, default level is logLevel.trace, default ancillaryInformation is empty string
  * @param {Object} data the data will be display
- * @param {String} level log level, use logLevel enum
- * @param {String} ancillaryInformation when ancillary Information not empty, it will be display
+ * @param {string} level log level, use logLevel enum
+ * @param {string} ancillaryInformation when ancillary Information not empty, it will be display
  */
 export function logObject(data: Object, level?: string, ancillaryInformation?: string): void;
 /**
@@ -120,7 +120,7 @@ export function logObject(data: Object, level?: string, ancillaryInformation?: s
 export function getLoggerDisplaySwitch(): boolean;
 /**
  * Set logger display switch
- * @param {Boolean} value display switch
+ * @param {boolean} value display switch
  */
 export function setLoggerDisplaySwitch(value: boolean): void;
 export namespace loggerSwitch {