mazey 3.10.1 → 3.11.0

package/lib/index.d.ts

@@ -1,1395 +1,1403 @@
-/**
- * @author: Mazey Chu
- */
-import { BrowserInfo, DefineListeners, ThrottleFunc, DebounceFunc, IsNumberOptions, AnyFunction, ZResResponse, ZResIsValidResOptions, RepeatUntilOptions, LoadScriptReturns, SimpleType, UnknownFnParams, UnknownFnReturn, UnknownObject, UnknownFn } from './typing';
-/**
- * EN: Computes the longest common substring of two strings.
- *
- * ZH: 计算两个字符串的最长公共子串
- *
- * Usage:
- *
- * ```
- * longestComSubstring('fish', 'finish');
- * ```
- *
- * Output:
- *
- * ```
- * 3
- * ```
- *
- * @param {string} aStr String
- * @param {string} bStr String
- * @returns {number} Length
- * @category Calculate and Formula
- */
-export declare function longestComSubstring(aStr: string, bStr: string): number;
-/**
- * Alias of `longestComSubstring`
- *
- * @hidden
- */
-export declare function calLongestCommonSubstring(aStr: string, bStr: string): number;
-/**
- * EN: Computes the longest common subsequence of two strings.
- *
- * ZH: 计算两个字符串的最长公共子序列
- *
- * Usage:
- *
- * ```
- * longestComSubsequence('fish', 'finish');
- * ```
- *
- * Output:
- *
- * ```
- * 4
- * ```
- *
- * @param {string} aStr 字符串
- * @param {string} bStr 字符串
- * @returns {number} 长度
- * @category Calculate and Formula
- */
-export declare function longestComSubsequence(aStr: string, bStr: string): number;
-/**
- * Alias of `longestComSubsequence`
- *
- * @hidden
- */
-export declare function calLongestCommonSubsequence(aStr: string, bStr: string): number;
-/**
- * Get the query param's value of the current Web URL(`location.search`).
- *
- * ```
- * // http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
- * // ?t1=1&t2=2&t3=3&t4=4
- * getQueryParam('t3'); // 3
- * getQueryParam('t4'); // 4
- * ```
- *
- * @param {string} param Query param.
- * @returns {string} value
- * @category URL
- */
-export declare function getQueryParam(param: string): string;
-/**
- * Returns the value of the specified query parameter in the input URL.
- *
- * @example
- * ```
- * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // Returns '3'
- * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // Returns '4'
- * ```
- *
- * @param {string} url The URL string.
- * @param {string} param The query parameter to retrieve the value for.
- * @returns {string|string[]} The value of the specified query parameter, or an empty string if the parameter is not found.
- * @category URL
- */
-export declare function getUrlParam(url: string, param: string): string | string[];
-/**
- * Update the query param's value of the input URL.
- *
- * Usage:
- *
- * ```
- * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three');
- * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four');
- * ```
- *
- * Output:
- *
- * ```
- * http://example.com/?t1=1&t2=2&t3=three&t4=4
- * http://example.com/?t1=1&t2=2&t3=3&t4=four
- * ```
- *
- * @param {string} url URL string.
- * @param {string} param Query param.
- * @param {string} value Param's value.
- * @returns {string} URL.
- * @category URL
- */
-export declare function updateQueryParam(url: string, param: string, value: string): string;
-/**
- * Get the hash query param's value of the current Web URL(`location.hash`).
- *
- * Usage:
- *
- * ```
- * // http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
- * // #2333?t1=1&t2=2&t3=3&t4=4
- * getHashQueryParam('t3');
- * getHashQueryParam('t4');
- * ```
- *
- * Output:
- *
- * ```
- * 3
- * 4
- * ```
- *
- * @param {string} param Query param.
- * @returns {string} value
- * @category URL
- */
-export declare function getHashQueryParam(param: string): string;
-/**
- * Get the domain of URL, and other params.
- *
- * Usage:
- *
- * ```
- * getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
- * getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
- * getDomain('http://example.com:7890/test/thanks', ['hostname']);
- * getDomain('http://example.com:7890/test/thanks', ['host']); // With Port
- * getDomain('http://example.com:7890/test/thanks', ['origin']);
- * getDomain('http://example.com:7890/test/thanks?id=1', ['origin', 'pathname', 'search']);
- * ```
- *
- * Output:
- *
- * ```
- * example.com
- * example.com/test/thanks
- * example.com
- * example.com:7890
- * http://example.com:7890
- * http://example.com:7890/test/thanks?id=1
- * ```
- *
- * @param {string} url
- * @param {array} rules Object.keys(location), ['href', 'origin', 'protocol', 'host', 'hostname', 'port', 'pathname', 'search', 'hash'], ['hostname', 'pathname'] = 'km.mazey.net/plugins/servlet/mobile'
- * @category URL
- */
-export declare function getDomain(url: string, rules?: string[]): string;
-/**
- * Transfer CamelCase to KebabCase.
- *
- * ```
- * convertCamelToKebab('ABC'); // a-b-c
- * convertCamelToKebab('aBC'); // a-b-c
- * ```
- *
- * @param {string} camelCase 'aBC' or 'ABC'
- * @returns {string} 'a-b-c'
- * @category Util
- */
-export declare function convertCamelToKebab(camelCase: string): string;
-/**
- * Alias of `convertCamelToKebab`
- *
- * @hidden
- */
-export declare function camelCaseToKebabCase(camelCase: string): string;
-/**
- * Transfer CamelCase to Underscore.
- *
- * ```
- * convertCamelToUnder('ABC'); // a_b_c
- * convertCamelToUnder('aBC'); // a_b_c
- * ```
- *
- * @param {string} camelCase 'aBC' or 'ABC'
- * @returns {string} 'a_b_c'
- * @category Util
- */
-export declare function convertCamelToUnder(camelCase: string): string;
-/**
- * Alias of `convertCamelToUnder`
- *
- * @hidden
- */
-export declare function camelCase2Underscore(camelCase: string): string;
-/**
- * Remove leading and trailing whitespace or specified characters from string.
- *
- * Note: This method is used to replace the native `String.prototype.trim()`. But it is not necessary to use it in modern browsers.
- *
- * ```
- * mTrim(' 1 2 3 '); // '1 2 3'
- * mTrim('abc '); // 'abc'
- * ```
- *
- * @param {string} str The string to trim.
- * @returns {string} Trimmed string.
- * @category Util
- * @hidden
- */
-export declare function mTrim(str: string): string;
-/**
- * Make a new line of HTML.
- *
- * ```
- * newLine('a\nb\nc'); // 'a<br />b<br />c'
- * newLine('a\n\nbc'); // 'a<br /><br />bc'
- * ```
- *
- * @param {string} str The string to make a new line.
- * @returns {string} A newline with `br`.
- * @category DOM
- */
-export declare function newLine(str: string): string;
-/**
- * Copy/Clone Object deeply.
- *
- * Usage:
- *
- * ```
- * deepCopy(['a', 'b', 'c']);
- * deepCopy('abc');
- * ```
- *
- * Output:
- *
- * ```
- * ['a', 'b', 'c']
- * 'abc'
- * ```
- *
- * @param {object} obj The value to clone.
- * @returns {object} Returns the deep cloned value.
- * @category Util
- */
-export declare function deepCopy<T>(obj: T): T;
-/**
- * Alias of `deepCopy`
- *
- * @hidden
- */
-export declare function deepCopyObject<T>(obj: T): T;
-/**
- * Check whether it is a valid JSON string.
- *
- * Usage:
- *
- * ```
- * isJSONString(`['a', 'b', 'c']`);
- * isJSONString(`["a", "b", "c"]`);
- * ```
- *
- * Output:
- *
- * ```
- * false
- * true
- * ```
- *
- * @param {string} str The string to check.
- * @returns {boolean} Return the result of checking.
- * @category Util
- */
-export declare function isJSONString(str: string): boolean;
-/**
- * Alias of `isJSONString`
- *
- * @hidden
- */
-export declare function isJsonString(str: string): boolean;
-/**
- * Produce a random string of number, `genRndNumString(7)` => '7658495'.
- *
- * ```
- * genRndNumString(4); // '9730'
- * genRndNumString(7); // '2262490'
- * ```
- *
- * @param {number} n Length
- * @returns {string} Return the random string.
- * @category Util
- */
-export declare function genRndNumString(n?: number): string;
-/**
- * Alias of `genRndNumString`
- *
- * @hidden
- */
-export declare function generateRndNum(n?: number): string;
-/**
- * 根据时间生成唯一标志的数字 genUniqueNumString() => 1538324722364123
- *
- * @param {number} n 随机数的长度
- * @category Util
- */
-export declare function genUniqueNumString(n?: number): string;
-/**
- * Alias of `genUniqueNumString`
- *
- * @hidden
- */
-export declare function generateUniqueNum(n?: number): string;
-/**
- * 浮点数转为百分比 0.2 => 20%
- *
- * @param {number} num 浮点数
- * @param {number} fixSize 保留几位浮点数
- * @category Util
- */
-export declare function floatToPercent(num: number, fixSize?: number): string;
-/**
- * 浮点数保留指定位
- *
- * @category Util
- */
-export declare function floatFixed(num: string, size?: number): string;
-/**
- * 阻止冒泡
- *
- * @category Event
- */
-export declare function cancelBubble(e: Event): void;
-/**
- * Modify `class`.
- *
- * ```
- * const dom = document.querySelector('#box');
- *
- * // Determine `class`
- * hasClass(dom, 'test');
- * // Add `class`
- * addClass(dom, 'test');
- * // Remove `class`
- * removeClass(dom, 'test');
- * ```
- *
- * @category DOM
- */
-export declare function hasClass(obj: HTMLElement, cls: string): boolean;
-/**
- * Modify `class`.
- *
- * ```
- * const dom = document.querySelector('#box');
- *
- * // Determine `class`
- * hasClass(dom, 'test');
- * // Add `class`
- * addClass(dom, 'test');
- * // Remove `class`
- * removeClass(dom, 'test');
- * ```
- *
- * @category DOM
- */
-export declare function addClass(obj: HTMLElement, cls: string): void;
-/**
- * Modify `class`.
- *
- * ```
- * const dom = document.querySelector('#box');
- *
- * // Determine `class`
- * hasClass(dom, 'test');
- * // Add `class`
- * addClass(dom, 'test');
- * // Remove `class`
- * removeClass(dom, 'test');
- * ```
- *
- * @category DOM
- */
-export declare function removeClass(obj: HTMLElement, cls: string): void;
-/**
- * EN: Throttle
- *
- * ZH: 节流
- *
- * ```
- * const foo = throttle(() => {
- *   console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
- * }, 1000, { leading: true });
- * ```
- *
- * Reference: [Lodash](https://lodash.com/docs/4.17.15#throttle)
- *
- * @category Util
- */
-export declare function throttle<T extends (...args: UnknownFnParams) => UnknownFnReturn>(func: T, wait: number, options?: {
-    leading?: boolean;
-    trailing?: boolean;
-}): ThrottleFunc<T>;
-/**
- * EN: Debounce
- *
- * ZH: 去抖
- *
- * ```
- * const foo = debounce(() => {
- *   console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
- * }, 1000, true);
- * ```
- *
- * @category Util
- */
-export declare function debounce<T extends (...args: UnknownFnParams) => UnknownFnReturn>(func: T, wait: number, immediate?: boolean): DebounceFunc<T>;
-/**
- * 获取间隔时间
- *
- * @example
- * ```js
- * console.log('getFriendlyInterval:', getFriendlyInterval(new Date('2020-03-28 00:09:27'), new Date('2023-04-18 10:54:00'), { type: 'd' })); // 1116
- * console.log('getFriendlyInterval:', getFriendlyInterval(1585325367000, 1681786440000, { type: 'text' })); // 1116 天 10 时 44 分 33 秒
- * console.log('getFriendlyInterval:', getFriendlyInterval('2020-03-28 00:09:27', '2023-04-18 10:54:00', { type: 'text' })); // 1116 天 10 时 44 分 33 秒
- * ```
- *
- * @param {number/Date} start 开始时间戳 1585325367122
- * @param {number/Date} end 结束时间戳 1585325367122
- * @param {string} options.type 返回类型 d: 2(天) text: 2 天 4 时...
- * @returns {string/number} 取决于 type
- * @category Util
- */
-export declare function getFriendlyInterval(start?: number | string | Date, end?: number | string | Date, options?: {
-    type?: string;
-}): number | string;
-/**
- * EN: Check whether it is a right number.
- *
- * ZH: 判断是否有效数字
- *
- * ```
- * isNumber(123); // true
- * isNumber('123'); // false
- * // Default: NaN, Infinity is not Number
- * isNumber(Infinity); // false
- * isNumber(Infinity, { isInfinityAsNumber: true }); // true
- * isNumber(NaN); // false
- * isNumber(NaN, { isNaNAsNumber: true, isInfinityAsNumber: true }); // true
- * ```
- *
- * @param {*} num 被判断的值
- * @param {boolean} options.isNaNAsNumber 是否 NaN 算数字（默认不算）
- * @param {boolean} options.isInfinityAsNumber 是否 无限 算数字（默认不算）
- * @returns {boolean} true 是数字
- * @category Util
- */
-export declare function isNumber(num: unknown, options?: IsNumberOptions): boolean;
-/**
- * 执行有效函数
- *
- * @param {function} fn 等待被执行的未知是否有效的函数
- * @category Util
- */
-export declare function doFn(fn: AnyFunction, ...params: Parameters<AnyFunction>): ReturnType<AnyFunction> | null;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage
- *
- * ```
- * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
- * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
- *
- * // or package in usage
- * const projectName = 'mazey';
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
- *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
- * ```
- *
- * @param {string} key 键
- * @returns {void} 返回值
- * @category Cache Data
- */
-export declare function setSessionStorage<T>(key: string, value?: T | null): void;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage
- *
- * ```
- * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
- * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
- *
- * // or package in usage
- * const projectName = 'mazey';
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
- *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
- * ```
- *
- * @param {string} key 键
- * @returns {any} 返回值
- * @category Cache Data
- */
-export declare function getSessionStorage<T>(key: string): T | null;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage
- *
- * ```
- * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
- * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
- *
- * // or package in usage
- * const projectName = 'mazey';
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
- *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
- * ```
- *
- * @param {string} key 键
- * @returns {void} 返回值
- * @category Cache Data
- */
-export declare function setLocalStorage<T>(key: string, value?: T | null): void;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage
- *
- * ```
- * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
- * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
- *
- * // or package in usage
- * const projectName = 'mazey';
- * function mSetLocalStorage (key, value) {
- *   return setLocalStorage(`${projectName}_${key}`, value);
- * }
- *
- * function mGetLocalStorage (key) {
- *   return getLocalStorage(`${projectName}_${key}`);
- * }
- * ```
- *
- * @param {string} key 键
- * @returns {any} 返回值
- * @category Cache Data
- */
-export declare function getLocalStorage<T>(key: string): T | null;
-/**
- * EN: Load a CSS file from the server.
- *
- * ZH: 动态加载 CSS 文件
- *
- * ```
- * loadCSS(
- *     'http://example.com/path/example.css',
- *     {
- *       id: 'iamid', // Optional, link ID, default none
- *     }
- *   )
- *   .then(
- *     res => {
- *       console.log(`Load CSS Success: ${res}`);
- *     }
- *   )
- *   .catch(
- *     err => {
- *       console.error(`Load CSS Fail: ${err.message}`)
- *     }
- *   );
- * ```
- *
- * @param {string} url -- css资源路径
- * @param {string} options.id -- link标签id
- * @returns {Promise<string>} true -- 加载成功
- * @category Load Resource
- */
-export declare function loadCSS(url: string, options?: {
-    id?: string;
-}): Promise<unknown>;
-/**
- * EN: Load a JavaScript file from the server and execute it.
- *
- * ZH: 动态加载 JavaScript 文件
- *
- * ```
- * loadScript(
- *     'http://example.com/static/js/plugin-2.1.1.min.js',
- *     {
- *       id: 'iamid', // (Optional) script ID, default none
- *       timeout: 5000, // (Optional) timeout, default `5000`
- *       isDefer: false, // (Optional) defer, default `false`
- *     }
- *   )
- *   .then(
- *     res => {
- *       console.log(`Load JavaScript script: ${res}`);
- *     }
- *   )
- *   .catch(
- *     err => {
- *       console.error(`Load JavaScript script: ${err.message}`)
- *     }
- *   );
- * ```
- *
- * @param {string} url -- JavaScript 资源路径
- * @param {string} options.id -- DOM ID
- * @param {function} options.callback -- 加载后回调函数
- * @param {number} options.timeout -- 超时时长
- * @param {boolean} options.isDefer -- 是否添加 defer 标签
- * @returns {Promise<string>} -- true 成功
- * @category Load Resource
- */
-export declare function loadScript(url: string, options?: {
-    id?: string;
-    callback?: (...params: UnknownFnParams) => UnknownFnReturn;
-    timeout?: number;
-    isDefer?: boolean;
-}): LoadScriptReturns;
-/**
- * 获取时间戳
- *
- * @category Util
- */
-export declare function mNow(): number;
-/**
- * EN: Handle Cookie.
- *
- * ZH: 设置/获取 Cookie
- *
- * ```
- * setCookie('test', '123', 30, 'example.com'); // key value day domain
- * getCookie('test'); // 123
- * ```
- *
- * @category Cache Data
- */
-export declare function setCookie(name: string, value: string, days?: number, domain?: string): void;
-/**
- * EN: Handle Cookie.
- *
- * ZH: 设置/获取 Cookie
- *
- * ```
- * setCookie('test', '123', 30, 'example.com'); // key value day domain
- * getCookie('test'); // 123
- * ```
- *
- * @category Cache Data
- */
-export declare function getCookie(name: string): string;
-/**
- * Delete a cookie by name.
- *
- * @param name - The name of the cookie to delete.
- * @returns `true` if the cookie was deleted successfully, `false` otherwise.
- * @category Cache Data
- */
-export declare function delCookie(name: string): boolean;
-/**
- * @hidden
- */
-interface WebPerformance {
-    [key: string]: string | number;
-}
-/**
- * Gets the first contentful paint (FCP) time of a web page using the Performance API.
- * The FCP time is the time it takes for the first piece of content to be painted on the screen.
- *
- * @returns A promise that resolves with the FCP time in milliseconds, or 0 if the 'paint' entry type is not supported.
- * @category Web Performance
- */
-export declare function getFCP(): Promise<number>;
-/**
- * Gets the first paint (FP) time of a web page using the Performance API.
- * The FP time is the time it takes for the first pixel to be painted on the screen.
- *
- * @returns A promise that resolves with the FP time in milliseconds, or 0 if the 'paint' entry type is not supported.
- * @category Web Performance
- */
-export declare function getFP(): Promise<number>;
-/**
- * Gets the largest contentful paint (LCP) time of a web page using the Performance API.
- * The LCP time is the time it takes for the largest piece of content to be painted on the screen.
- *
- * @returns A promise that resolves with the LCP time in milliseconds, or 0 if the 'largest-contentful-paint' entry type is not supported.
- * @category Web Performance
- */
-export declare function getLCP(): Promise<number>;
-/**
- * Gets the first input delay (FID) of a web page using the Performance API.
- * The FID is the time it takes for the first user input to be processed by the browser.
- *
- * @returns A promise that resolves with the FID in milliseconds, or 0 if the 'first-input' entry type is not supported.
- * @category Web Performance
- */
-export declare function getFID(): Promise<number>;
-/**
- * Gets the Cumulative Layout Shift (CLS) score of a web page using the Performance API.
- * The CLS score is a measure of how much the page layout shifts during loading.
- *
- * @returns A promise that resolves with the CLS score, or 0 if the 'layout-shift' entry type is not supported.
- * @category Web Performance
- */
-export declare function getCLS(): Promise<number>;
-/**
- * Gets the time to first byte (TTFB) of a web page using the Performance API.
- * The TTFB is the time it takes for the first byte of the response to be received by the browser.
- *
- * @returns The TTFB in milliseconds, or 0 if the navigation timing information is not available.
- * @category Web Performance
- */
-export declare function getTTFB(): Promise<number>;
-/**
- * EN: Get page load time(`PerformanceNavigationTiming`).
- *
- * ZH: 获取页面加载相关的各项数据
- *
- * @remarks
- * This function uses the [`PerformanceNavigationTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming) API to get page load time data.
- * The `PerformanceNavigationTiming` API provides more accurate and detailed information about page load time than the deprecated [`PerformanceTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming) API.
- * If you are using an older browser that does not support `PerformanceNavigationTiming`, you can still use the `PerformanceTiming` API by using the previous version of this library ([`v3.9.7`](https://www.npmjs.com/package/mazey/v/3.9.7)).
- *
- * Usage:
- *
- * ```
- * // `camelCase：false` (Default) Return underline(`a_b`) data.
- * // `camelCase：true` Return hump(`aB`) data.
- * getPerformance()
- *  .then(res => {
- *   console.log(JSON.stringify(res));
- *  })
- *  .catch(console.error);
- * ```
- *
- * Output:
- *
- * ```
- * {"source":"PerformanceNavigationTiming","os":"others","os_version":"","device_type":"pc","network":"4g","screen_direction":"","unload_time":0,"redirect_time":0,"dns_time":0,"tcp_time":0,"ssl_time":0,"response_time":2,"download_time":2,"first_paint_time":288,"first_contentful_paint_time":288,"dom_ready_time":0,"onload_time":0,"white_time":0,"render_time":0,"decoded_body_size":718,"encoded_body_size":718}
- * ```
- *
- * Results:
- *
- * | Attribute | Description | Type | Values |
- * | :------------ | :------------ | :------------ | :------------ |
- * | dns_time | DNS Lookup | number | domainLookupEnd - domainLookupStart |
- * | tcp_time | Connection Negotiation | number | connectEnd - connectStart |
- * | response_time | Requests and Responses | number | responseStart - requestStart |
- * | white_time | White Screen | number | responseStart - navigationStart |
- * | dom_ready_time | Dom Ready | number | domContentLoadedEventStart - navigationStart |
- * | onload_time | Onload | number | loadEventStart - navigationStart |
- * | render_time | EventEnd | number | loadEventEnd -navigationStart |
- * | unload_time | Unload | number | (Optional) unloadEventEnd - unloadEventStart |
- * | redirect_time | Redirect | number | (Optional) redirectEnd - redirectStart |
- * | ssl_time | SSL | number | (Optional) connectEnd - secureConnectionStart |
- * | download_time | Download | number | (Optional) responseEnd - responseStart |
- *
- * @param {boolean} camelCase -- false（默认） 以下划线形式返回数据 true 以驼峰形式返回数据
- * @returns {Promise<object>} 加载数据
- * @category Web Performance
- */
-export declare function getPerformance(camelCase?: boolean): Promise<WebPerformance | Error>;
-/**
- * EN: Hit probability (1% ~ 100%).
- *
- * ZH: 百分位概率
- *
- * Usage:
- *
- * ```
- * inRate(0.5); // 0.01 ~ 1 true/false
- * ```
- *
- * Output:
- *
- * ```
- * true
- * ```
- *
- * Example: Test the precision.
- *
- * ```
- * // Test
- * let trueCount = 0;
- * let falseCount = 0;
- * new Array(1000000).fill(0).forEach(() => {
- *   if (inRate(0.5)) {
- *     trueCount++;
- *   } else {
- *     falseCount++;
- *   }
- * });
- * console.log(trueCount, falseCount); // 499994 500006
- * ```
- *
- * @param {number} rate -- 0.1 ~ 1 => 1% ~ 100%
- * @returns {boolean} true 命中
- * @category Calculate and Formula
- */
-export declare function inRate(rate: number): boolean;
-/**
- * EN: Detect the margin of Safety. Determine if it is a secure PWA environment that it can run.
- *
- * ZH: 判断是否是安全的 PWA 环境
- *
- * Usage:
- *
- * ```
- * isSafePWAEnv();
- * ```
- *
- * Output:
- *
- * ```
- * true
- * ```
- *
- * @returns {boolean} true 是
- * @category Browser Information
- */
-export declare function isSafePWAEnv(): boolean;
-/**
- * EN: Browser Information
- *
- * ZH: 返回浏览器信息 https://github.com/JowayYoung/juejin-code/blob/master/browser-type.js
- *
- * Usage:
- *
- * ```
- * getBrowserInfo();
- * ```
- *
- * Output:
- *
- * ```
- * {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
- * ```
- *
- * Results:
- *
- * | Attribute | Description | Type | Values |
- * | :------------ | :------------ | :------------ | :------------ |
- * | **system** | System | string | android, ios, windows, macos, linux |
- * | systemVs | System version | string | windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 <br />macos: ... |
- * | platform | Platform | string | desktop, mobile |
- * | engine | Engine | string | webkit, gecko, presto, trident |
- * | engineVs | Engine version | string | - |
- * | supporter | Supporter | string | edge, opera, chrome, safari, firefox, iexplore |
- * | supporterVs | Supporter version | string | - |
- * | shell | Shell | string | (Optional) wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
- * | shellVs | Shell version | string | (Optional) 20/... |
- * | appleType | Apple device type | string | (Optional) ipad, iphone, ipod, iwatch |
- *
- * Example: Determine the environment of the mobile QQ.
- *
- * ```
- * const { system, shell } = getBrowserInfo();
- * const isMobileQQ = ['android', 'ios'].includes(system) && ['qq_browser', 'qq_app'].includes(shell);
- * ```
- *
- * @returns 浏览器信息
- * @category Browser Information
- */
-export declare function getBrowserInfo(): BrowserInfo;
-/**
- * 去除 HTML 标签
- *
- * @param {string} str 带html标签的字符串
- * @returns {string} 字符串
- * @category Util
- */
-export declare function clearHtml(str: string, options?: {
-    removeNewLine?: boolean;
-}): string;
-/**
- * Sanitizes user input to prevent XSS attacks
- *
- * @param input - The input string to sanitize
- * @returns The sanitized input string
- * @category Util
- */
-export declare function sanitizeInput(input: string): string;
-/**
- * Reverses the sanitization done by the `sanitizeInput` function.
- *
- * @param input - The input string to unsanitize
- * @returns The unsanitized input string
- * @category Util
- */
-export declare function unsanitize(input: string): string;
-/**
- * 截取字符串，中文算 2 个字节
- *
- * @param {string} str 要截取的字符串
- * @param {number} len
- * @param {boolean} hasDot
- * @returns {string} 返回截取后的字符串
- * @category Util
- */
-export declare function truncateZHString(str: string, len: number, hasDot?: boolean): string;
-/**
- * Alias of `truncateZHString`
- *
- * @hidden
- */
-export declare function cutCHSString(str: string, len: number, hasDot?: boolean): string;
-/**
- * EN: Check whether the page is loaded successfully (Keep the compatibility if the browser's `load` event has been triggered).
- *
- * ZH: 页面加载完成
- *
- * ```
- * windowLoaded(30) // second
- *   .then(res => {
- *     console.log(`Load Success: ${res}`); // Load Success: load
- *   })
- *   .catch(err => {
- *     console.log(`Load Timeout or Fail: ${err.message}`);
- *   });
- * ```
- *
- * @param {number} timeout 超时时间 / 单位：秒
- * @returns {Promise<string>} document is loaded? 'complete' 'load' / 'timeout'
- * @category Load Resource
- */
-export declare function windowLoaded(timeout?: number): Promise<string | Error>;
-/**
- * EN: Add `<style>` in `<head>`.
- *
- * ZH: 添加样式标签; style: 样式标签内的字符串; id: `<style>` 标签的 `id`; 返回: 添加成功/失败
- *
- * Example 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
- *
- * ```
- * addStyle(
- *   `
- *     body {
- *       background-color: #333;
- *     }
- *   `,
- *   {
- *     id: 'test',
- *   }
- * );
- * // <style id="test">
- * //   body {
- * //     background-color: #333;
- * //   }
- * // </style>
- * ```
- *
- * Example 2: Add the `<style>` without `id`, and repeated invoking will add a new one.
- *
- * ```
- * addStyle(
- *   `
- *     body {
- *       background-color: #444;
- *     }
- *   `
- * );
- * // <style>
- * //   body {
- * //     background-color: #444;
- * //   }
- * // </style>
- * ```
- *
- * @category DOM
- */
-export declare function addStyle(style: string, options?: {
-    id?: string;
-}): boolean;
-/**
- * EN: Custom console printing (`console`).
- *
- * ZH: 生成自定义控制台打印
- *
- * Usage:
- *
- * ```
- * const myConsole = genCustomConsole('MazeyLog:');
- * myConsole.log('I am string.');
- * myConsole.info('I am boolean.', true);
- * myConsole.info('I am number.', 123, 456);
- * myConsole.info('I am object.', { a: 123, b: 456});
- * ```
- *
- * Output:
- *
- * ```
- * MazeyLog: I am string.
- * MazeyLog: I am boolean. true
- * MazeyLog: I am number. 123 456
- * MazeyLog: I am object. {a: 123, b: 456}
- * ```
- *
- * @param {string} prefix 前缀
- * @param {string} locales A locale string.
- * @param {function} logFn The function with Log.
- * @param {function} errorFn The function with Error.
- * @returns {object} 新实例
- * @category Debug
- */
-export declare function genCustomConsole(prefix?: string, options?: {
-    isClosed?: boolean;
-    showWrap?: boolean;
-    showDate?: boolean;
-    locales?: string;
-    logFn?: () => void;
-    errorFn?: () => void;
-}): Console;
-/**
- * Verify the validity of axios response.
- *
- * Reference: [Handling Errors](https://axios-http.com/docs/handling_errors)
- *
- * @category Util
- * @hidden
- */
-export declare function zAxiosIsValidRes(res: ZResResponse | undefined, options?: ZResIsValidResOptions): boolean;
-/**
- * Verify the validity of a non-empty array.
- *
- * @category Util
- */
-export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
-/**
- * Determine the validity of the data.
- *
- * Usage:
- *
- * ```
- * const validData = {
- *   a: {
- *     b: {
- *       c: 413
- *     }
- *   }
- * };
- *
- * const isValidDataResA = isValidData(validData, ['a', 'b', 'c'], 2333);
- * const isValidDataResB = isValidData(validData, ['a', 'b', 'c'], 413);
- * const isValidDataResC = isValidData(validData, ['d', 'd'], 413);
- *
- * console.log('isValidDataResA:', isValidDataResA);
- * console.log('isValidDataResB:', isValidDataResB);
- * console.log('isValidDataResC:', isValidDataResC);
- * ```
- *
- * Output:
- *
- * ```
- * isValidDataResA: false
- * isValidDataResB: true
- * isValidDataResC: false
- * ```
- *
- * @param {any} data Original Data
- * @param {string[]} attributes Data Attributes
- * @param {any} validValue Given Value for verifying.
- * @returns {boolean} Return TRUE if the data is valid.
- * @category Util
- */
-export declare function isValidData(data: UnknownObject, attributes: string[], validValue: SimpleType): boolean;
-/**
- * 语义化文件大小, 把字节转换成正常文件大小.
- *
- * @category Util
- */
-export declare function getFileSize(size: number): string;
-/**
- * Detect webp support.
- *
- * Reference: [Detect WEBP Support with JavaScript](https://davidwalsh.name/detect-webp)
- *
- * @category Browser Information
- */
-export declare function isSupportWebp(): Promise<boolean>;
-/**
- * Generate a Hash Code from a string.
- *
- * Reference: [Generate a Hash from string in Javascript](https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery)
- *
- * @category Util
- */
-export declare function genHashCode(str: string): number;
-/**
- * Return the formatted date string in the given format.
- *
- * Usage:
- *
- * ```
- * console.log('Default formatDate value:', formatDate());
- * console.log('String formatDate value:', formatDate('Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)', 'yyyy-MM-dd hh:mm:ss'));
- * console.log('Number formatDate value:', formatDate(1641881235000, 'yyyy-MM-dd hh:mm:ss'));
- * console.log('Date formatDate value:', formatDate(new Date(2014, 1, 11), 'MM/dd/yyyy'));
- * ```
- *
- * Output:
- *
- * ```
- * Default formatDate value: 2023-01-11
- * String formatDate value: 2022-01-11 14:12:26
- * Number formatDate value: 2022-01-11 14:07:15
- * Date formatDate value: 02/11/2014
- * ```
- *
- * @param {Date|number|string} dateIns Original Date
- * @param {string} format Format String
- * @returns {string} Return the formatted date string.
- * @category Util
- */
-export declare function formatDate(dateIns?: Date | number | string, format?: string): string;
-/**
- * Get event container.
- *
- * @category Event
- * @hidden
- */
-export declare function getDefineListeners(): DefineListeners;
-/**
- * Add event.
- *
- * @param type
- * @param fn
- * @category Event
- */
-export declare function addEvent(type: string, fn: UnknownFn): void;
-/**
- * Invoke event.
- *
- * @param type
- * @category Event
- */
-export declare function invokeEvent(type: string): void;
-/**
- * Remove event.
- *
- * @param type
- * @param fn
- * @category Event
- */
-export declare function removeEvent(type: string, fn: UnknownFn): void;
-/**
- * Checks if the given string is a valid URL, including **scheme URLs**.
- *
- * @example
- * ```js
- * isValidUrl('https://www.example.com'); // true
- * isValidUrl('http://example.com/path/exx/ss'); // true
- * isValidUrl('https://www.example.com/?q=hello&age=24#world'); // true
- * isValidUrl('http://www.example.com/#world?id=9'); // true
- * isValidUrl('ftp://example.com'); // true
- * ```
- *
- * @remarks
- * If you are specifically checking for HTTP/HTTPS URLs, it is recommended to use the `isValidHttpUrl` function instead.
- * The `isValidUrl` function matches all scheme URLs, including FTP and other non-HTTP schemes.
- *
- * @param url - The URL to check.
- * @returns Returns `true` if the given string is a valid URL, else `false`.
- * @category URL
- */
-export declare function isValidUrl(url: string): boolean;
-/**
- * Check if the given string is a valid HTTP/HTTPS URL.
- *
- * @example
- * ```js
- * isValidHttpUrl('https://www.example.com'); // true
- * isValidHttpUrl('http://example.com/path/exx/ss'); // true
- * isValidHttpUrl('https://www.example.com/?q=hello&age=24#world'); // true
- * isValidHttpUrl('http://www.example.com/#world?id=9'); // true
- * isValidHttpUrl('ftp://example.com'); // false
- * ```
- *
- * @param url
- * @returns {boolean} Return true if the given string is a valid HTTP/HTTPS URL.
- * @category URL
- */
-export declare function isValidHttpUrl(url: string): boolean;
-/**
- * Check if the given string is a mobile phone number.
- *
- * @example
- * ```js
- * console.log(isMobile('13800138000')); // true
- * console.log(isMobile('1380013800')); // false
- * console.log(isMobile('138001380000')); // false
- * console.log(isMobile('1380013800a')); // false
- * ```
- *
- * @param mobile
- * @returns {boolean} Return true if the given string is a mobile phone number.
- * @category Util
- */
-export declare function isValidPhoneNumber(mobile: string): boolean;
-/**
- * Check if the given string is a valid email.
- *
- * @example
- * ```js
- * console.log(isValidEmail('mazeyqian@gmail.com')); // true
- * ```
- *
- * @param email
- * @returns {boolean} Return true if the given string is a valid email.
- * @category Util
- */
-export declare function isValidEmail(email: string): boolean;
-/**
- * Convert a given 10-hex number to a lowercase 26-hex string.
- *
- * @example
- * ```js
- * console.log(convert10To26(1)); // a
- * console.log(convert10To26(26)); // z
- * console.log(convert10To26(27)); // aa
- * console.log(convert10To26(52)); // az
- * console.log(convert10To26(53)); // ba
- * ```
- *
- * @param {number} num
- * @returns {string} Return a lowercase 26-hex string.
- * @category Util
- */
-export declare function convert10To26(num: number): string;
-/**
- * EN: Get the file type of the url.
- *
- * ZH: 获取文件后缀名
- *
- * @example
- * ```js
- * console.log(getUrlFileType('https://example.com/a/b/c.png')); // png
- * console.log(getUrlFileType('https://example.com/a/b/c.jpg')); // jpg
- * console.log(getUrlFileType('https://example.com/a/b/c.jpeg')); // jpeg
- * console.log(getUrlFileType('/a/b/c.jpeg')); // jpeg
- * console.log(getUrlFileType('https://example.com/a/b/c.v/a')); // ''
- * ```
- *
- * @param url
- * @returns
- * @category URL
- */
-export declare function getUrlFileType(url: string): boolean | string;
-/**
- * Sets the width and height of all images on the page based on their `src` attribute.
- * The `src` attribute should contain `width` and/or `height` values in the format "width=100" or "height=100".
- * If jQuery is available, this function uses jQuery to select the images. Otherwise, it uses pure JavaScript.
- *
- * @example
- * ```
- * // Example images with `src` attributes containing `width` and/or `height` values
- * const img1 = document.createElement('img');
- * img1.setAttribute('src', 'https://example.com/example.png?width=2233&height=111');
- * document.body.appendChild(img1);
- *
- * const img2 = document.createElement('img');
- * img2.setAttribute('src', 'https://example.com/example.png?width=100%&height=auto');
- * document.body.appendChild(img2);
- * ```
- *
- * @returns {boolean} - Returns `true` if images were found and their dimensions were set, otherwise `false`.
- * @category DOM
- */
-export declare function setImgWidHeiBySrc(): boolean;
-/**
- * Generate the inline style string from the given parameters, First parameter is the ClassNames, Second parameter is the style array.
- *
- * @example
- * ```js
- * console.log(genStyleString('a', [ 'color:red' ])); // '.a{color:red;}'
- * console.log(genStyleString('b', [ 'color:red', 'font-size:12px' ])); // '.b{color:red;font-size:12px;}'
- * ```
- *
- * @param {string} className
- * @param {Array} styleArray
- * @returns {string} Return the inline style string.
- * @category DOM
- */
-export declare function genStyleString(className: string, styleArray: Array<string>): string;
-/**
- * Load an image from the given URL.
- *
- * The target image will be loaded in the background, and the Promise status will change after the image is loaded. If the image fails to load, the Promise status will change to `reject` with the error object. If the image is loaded successfully, the Promise status will change to `resolve` with the image object. This method can be used to preload images and cache them in the browser. It can also be used to implement lazy loading of images.
- *
- * Note that this method will not add the image to the DOM.
- *
- * @example
- * ```js
- * loadImage('https://example.com/example.png')
- *   .then((img) => {
- *     console.log(img);
- *   })
- *   .catch((err) => {
- *     console.log(err);
- *   });
- * ```
- *
- * @param {string} url - The URL of the image to load.
- * @returns {Promise} A Promise that resolves with the loaded image or rejects with an error.
- * @category Load Resource
- */
-export declare function loadImage(url: string): Promise<HTMLImageElement>;
-/**
- * Get the current version.
- *
- * @hidden
- */
-export declare function getCurrentVersion(): string;
-/**
- * Repeatedly fires a callback function with a certain interval until a specified condition is met.
- *
- * @param callback The callback function to fire.
- * @param options An object containing the options for the function.
- * @param options.interval The interval between each firing of the callback function, in milliseconds. Defaults to 1000.
- * @param options.times The maximum number of times to fire the callback function. Defaults to 10.
- * @param options.context The context to use when calling the callback function. Defaults to null.
- * @param options.args An array of arguments to pass to the callback function.
- * @param condition A function that takes the result of the callback function as its argument and returns a boolean value indicating whether the condition has been met. Defaults to a function that always returns true.
- * @category Util
- */
-export declare function repeatUntilConditionMet<T extends (...args: UnknownFnParams) => UnknownFnReturn>(callback: T, options?: RepeatUntilOptions, condition?: (result: ReturnType<T>) => boolean): void;
-/**
- * Load a script from the given URL if it (`window['attribute']`) has not already been loaded.
- *
- * @example
- * ```js
- * loadScriptIfUndefined('jQuery', 'https://example.com/lib/jquery.min.js')
- *   .then(() => {
- *     console.log('jQuery is loaded.');
- *   })
- *   .catch(err => {
- *     console.log('Failed to load jQuery.', err);
- *   });
- * ```
- *
- * @param {string} windowAttribute - The name of the window attribute to check (e.g. `jQuery`, `axios`, etc.).
- * @param {string} url - The URL of the script to load.
- * @returns {Promise} A Promise that resolves when the script has been loaded.
- * @category Load Resource
- */
-export declare function loadScriptIfUndefined(windowAttribute: string, url: string): LoadScriptReturns;
-/**
- * Retrieve a query parameter from a script URL in the browser.
- *
- * @param param - The name of the query parameter to retrieve.
- * @param matchString - An optional substring to match in the script URL.
- *                      If not provided, defaults to matching the ".js" substring.
- * @returns The decoded value of the specified query parameter, or an empty string if no matching parameter is found.
- * @category URL
- */
-export declare function getScriptQueryParam(param: string, matchString?: string): string;
-export {};
+/**
+ * @author: Mazey Chu
+ */
+import { BrowserInfo, DefineListeners, ThrottleFunc, DebounceFunc, IsNumberOptions, AnyFunction, ZResResponse, ZResIsValidResOptions, RepeatUntilOptions, LoadScriptReturns, SimpleType, UnknownFnParams, UnknownFnReturn, UnknownObject, UnknownFn } from './typing';
+/**
+ * EN: Computes the longest common substring of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子串
+ *
+ * Usage:
+ *
+ * ```
+ * longestComSubstring('fish', 'finish');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * 3
+ * ```
+ *
+ * @param {string} aStr String
+ * @param {string} bStr String
+ * @returns {number} Length
+ * @category Calculate and Formula
+ */
+export declare function longestComSubstring(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubstring`
+ *
+ * @hidden
+ */
+export declare function calLongestCommonSubstring(aStr: string, bStr: string): number;
+/**
+ * EN: Computes the longest common subsequence of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子序列
+ *
+ * Usage:
+ *
+ * ```
+ * longestComSubsequence('fish', 'finish');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * 4
+ * ```
+ *
+ * @param {string} aStr 字符串
+ * @param {string} bStr 字符串
+ * @returns {number} 长度
+ * @category Calculate and Formula
+ */
+export declare function longestComSubsequence(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubsequence`
+ *
+ * @hidden
+ */
+export declare function calLongestCommonSubsequence(aStr: string, bStr: string): number;
+/**
+ * Get the query param's value of the current Web URL(`location.search`).
+ *
+ * ```
+ * // http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
+ * // ?t1=1&t2=2&t3=3&t4=4
+ * getQueryParam('t3'); // 3
+ * getQueryParam('t4'); // 4
+ * ```
+ *
+ * @param {string} param Query param.
+ * @returns {string} value
+ * @category URL
+ */
+export declare function getQueryParam(param: string): string;
+/**
+ * Returns the value of the specified query parameter in the input URL.
+ *
+ * @example
+ * ```
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // Returns '3'
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // Returns '4'
+ * ```
+ *
+ * @param {string} url The URL string.
+ * @param {string} param The query parameter to retrieve the value for.
+ * @returns {string|string[]} The value of the specified query parameter, or an empty string if the parameter is not found.
+ * @category URL
+ */
+export declare function getUrlParam(url: string, param: string): string | string[];
+/**
+ * Update the query param's value of the input URL.
+ *
+ * Usage:
+ *
+ * ```
+ * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three');
+ * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * http://example.com/?t1=1&t2=2&t3=three&t4=4
+ * http://example.com/?t1=1&t2=2&t3=3&t4=four
+ * ```
+ *
+ * @param {string} url URL string.
+ * @param {string} param Query param.
+ * @param {string} value Param's value.
+ * @returns {string} URL.
+ * @category URL
+ */
+export declare function updateQueryParam(url: string, param: string, value: string): string;
+/**
+ * Get the hash query param's value of the current Web URL(`location.hash`).
+ *
+ * Usage:
+ *
+ * ```
+ * // http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
+ * // #2333?t1=1&t2=2&t3=3&t4=4
+ * getHashQueryParam('t3');
+ * getHashQueryParam('t4');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * 3
+ * 4
+ * ```
+ *
+ * @param {string} param Query param.
+ * @returns {string} value
+ * @category URL
+ */
+export declare function getHashQueryParam(param: string): string;
+/**
+ * Get the domain of URL, and other params.
+ *
+ * Usage:
+ *
+ * ```
+ * getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
+ * getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
+ * getDomain('http://example.com:7890/test/thanks', ['hostname']);
+ * getDomain('http://example.com:7890/test/thanks', ['host']); // With Port
+ * getDomain('http://example.com:7890/test/thanks', ['origin']);
+ * getDomain('http://example.com:7890/test/thanks?id=1', ['origin', 'pathname', 'search']);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * example.com
+ * example.com/test/thanks
+ * example.com
+ * example.com:7890
+ * http://example.com:7890
+ * http://example.com:7890/test/thanks?id=1
+ * ```
+ *
+ * @param {string} url
+ * @param {array} rules Object.keys(location), ['href', 'origin', 'protocol', 'host', 'hostname', 'port', 'pathname', 'search', 'hash'], ['hostname', 'pathname'] = 'km.mazey.net/plugins/servlet/mobile'
+ * @category URL
+ */
+export declare function getDomain(url: string, rules?: string[]): string;
+/**
+ * Transfer CamelCase to KebabCase.
+ *
+ * ```
+ * convertCamelToKebab('ABC'); // a-b-c
+ * convertCamelToKebab('aBC'); // a-b-c
+ * ```
+ *
+ * @param {string} camelCase 'aBC' or 'ABC'
+ * @returns {string} 'a-b-c'
+ * @category Util
+ */
+export declare function convertCamelToKebab(camelCase: string): string;
+/**
+ * Alias of `convertCamelToKebab`
+ *
+ * @hidden
+ */
+export declare function camelCaseToKebabCase(camelCase: string): string;
+/**
+ * Transfer CamelCase to Underscore.
+ *
+ * ```
+ * convertCamelToUnder('ABC'); // a_b_c
+ * convertCamelToUnder('aBC'); // a_b_c
+ * ```
+ *
+ * @param {string} camelCase 'aBC' or 'ABC'
+ * @returns {string} 'a_b_c'
+ * @category Util
+ */
+export declare function convertCamelToUnder(camelCase: string): string;
+/**
+ * Alias of `convertCamelToUnder`
+ *
+ * @hidden
+ */
+export declare function camelCase2Underscore(camelCase: string): string;
+/**
+ * Remove leading and trailing whitespace or specified characters from string.
+ *
+ * Note: This method is used to replace the native `String.prototype.trim()`. But it is not necessary to use it in modern browsers.
+ *
+ * ```
+ * mTrim(' 1 2 3 '); // '1 2 3'
+ * mTrim('abc '); // 'abc'
+ * ```
+ *
+ * @param {string} str The string to trim.
+ * @returns {string} Trimmed string.
+ * @category Util
+ * @hidden
+ */
+export declare function mTrim(str: string): string;
+/**
+ * Make a new line of HTML.
+ *
+ * ```
+ * newLine('a\nb\nc'); // 'a<br />b<br />c'
+ * newLine('a\n\nbc'); // 'a<br /><br />bc'
+ * ```
+ *
+ * @param {string} str The string to make a new line.
+ * @returns {string} A newline with `br`.
+ * @category DOM
+ */
+export declare function newLine(str: string): string;
+/**
+ * Copy/Clone Object deeply.
+ *
+ * Usage:
+ *
+ * ```
+ * deepCopy(['a', 'b', 'c']);
+ * deepCopy('abc');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * ['a', 'b', 'c']
+ * 'abc'
+ * ```
+ *
+ * @param {object} obj The value to clone.
+ * @returns {object} Returns the deep cloned value.
+ * @category Util
+ */
+export declare function deepCopy<T>(obj: T): T;
+/**
+ * Alias of `deepCopy`
+ *
+ * @hidden
+ */
+export declare function deepCopyObject<T>(obj: T): T;
+/**
+ * Check whether it is a valid JSON string.
+ *
+ * Usage:
+ *
+ * ```
+ * isJSONString(`['a', 'b', 'c']`);
+ * isJSONString(`["a", "b", "c"]`);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * false
+ * true
+ * ```
+ *
+ * @param {string} str The string to check.
+ * @returns {boolean} Return the result of checking.
+ * @category Util
+ */
+export declare function isJSONString(str: string): boolean;
+/**
+ * Alias of `isJSONString`
+ *
+ * @hidden
+ */
+export declare function isJsonString(str: string): boolean;
+/**
+ * Produce a random string of number, `genRndNumString(7)` => '7658495'.
+ *
+ * ```
+ * genRndNumString(4); // '9730'
+ * genRndNumString(7); // '2262490'
+ * ```
+ *
+ * @param {number} n Length
+ * @returns {string} Return the random string.
+ * @category Util
+ */
+export declare function genRndNumString(n?: number): string;
+/**
+ * Alias of `genRndNumString`
+ *
+ * @hidden
+ */
+export declare function generateRndNum(n?: number): string;
+/**
+ * 根据时间生成唯一标志的数字 genUniqueNumString() => 1538324722364123
+ *
+ * @param {number} n 随机数的长度
+ * @category Util
+ */
+export declare function genUniqueNumString(n?: number): string;
+/**
+ * Alias of `genUniqueNumString`
+ *
+ * @hidden
+ */
+export declare function generateUniqueNum(n?: number): string;
+/**
+ * 浮点数转为百分比 0.2 => 20%
+ *
+ * @param {number} num 浮点数
+ * @param {number} fixSize 保留几位浮点数
+ * @category Util
+ */
+export declare function floatToPercent(num: number, fixSize?: number): string;
+/**
+ * 浮点数保留指定位
+ *
+ * @category Util
+ */
+export declare function floatFixed(num: string, size?: number): string;
+/**
+ * 阻止冒泡
+ *
+ * @category Event
+ */
+export declare function cancelBubble(e: Event): void;
+/**
+ * Modify `class`.
+ *
+ * ```
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function hasClass(obj: HTMLElement, cls: string): boolean;
+/**
+ * Modify `class`.
+ *
+ * ```
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function addClass(obj: HTMLElement, cls: string): void;
+/**
+ * Modify `class`.
+ *
+ * ```
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function removeClass(obj: HTMLElement, cls: string): void;
+/**
+ * EN: Throttle
+ *
+ * ZH: 节流
+ *
+ * ```
+ * const foo = throttle(() => {
+ *   console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
+ * }, 1000, { leading: true });
+ * ```
+ *
+ * Reference: [Lodash](https://lodash.com/docs/4.17.15#throttle)
+ *
+ * @category Util
+ */
+export declare function throttle<T extends (...args: UnknownFnParams) => UnknownFnReturn>(func: T, wait: number, options?: {
+    leading?: boolean;
+    trailing?: boolean;
+}): ThrottleFunc<T>;
+/**
+ * EN: Debounce
+ *
+ * ZH: 去抖
+ *
+ * ```
+ * const foo = debounce(() => {
+ *   console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
+ * }, 1000, true);
+ * ```
+ *
+ * @category Util
+ */
+export declare function debounce<T extends (...args: UnknownFnParams) => UnknownFnReturn>(func: T, wait: number, immediate?: boolean): DebounceFunc<T>;
+/**
+ * 获取间隔时间
+ *
+ * @example
+ * ```js
+ * console.log('getFriendlyInterval:', getFriendlyInterval(new Date('2020-03-28 00:09:27'), new Date('2023-04-18 10:54:00'), { type: 'd' })); // 1116
+ * console.log('getFriendlyInterval:', getFriendlyInterval(1585325367000, 1681786440000, { type: 'text' })); // 1116 天 10 时 44 分 33 秒
+ * console.log('getFriendlyInterval:', getFriendlyInterval('2020-03-28 00:09:27', '2023-04-18 10:54:00', { type: 'text' })); // 1116 天 10 时 44 分 33 秒
+ * ```
+ *
+ * @param {number/Date} start 开始时间戳 1585325367122
+ * @param {number/Date} end 结束时间戳 1585325367122
+ * @param {string} options.type 返回类型 d: 2(天) text: 2 天 4 时...
+ * @returns {string/number} 取决于 type
+ * @category Util
+ */
+export declare function getFriendlyInterval(start?: number | string | Date, end?: number | string | Date, options?: {
+    type?: string;
+}): number | string;
+/**
+ * EN: Check whether it is a right number.
+ *
+ * ZH: 判断是否有效数字
+ *
+ * ```
+ * isNumber(123); // true
+ * isNumber('123'); // false
+ * // Default: NaN, Infinity is not Number
+ * isNumber(Infinity); // false
+ * isNumber(Infinity, { isInfinityAsNumber: true }); // true
+ * isNumber(NaN); // false
+ * isNumber(NaN, { isNaNAsNumber: true, isInfinityAsNumber: true }); // true
+ * ```
+ *
+ * @param {*} num 被判断的值
+ * @param {boolean} options.isNaNAsNumber 是否 NaN 算数字（默认不算）
+ * @param {boolean} options.isInfinityAsNumber 是否 无限 算数字（默认不算）
+ * @returns {boolean} true 是数字
+ * @category Util
+ */
+export declare function isNumber(num: unknown, options?: IsNumberOptions): boolean;
+/**
+ * 执行有效函数
+ *
+ * @param {function} fn 等待被执行的未知是否有效的函数
+ * @category Util
+ */
+export declare function doFn(fn: AnyFunction, ...params: Parameters<AnyFunction>): ReturnType<AnyFunction> | null;
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage
+ *
+ * ```
+ * setSessionStorage('test', '123');
+ * getSessionStorage('test'); // 123
+ * setLocalStorage('test', '123');
+ * getLocalStorage('test'); // 123
+ *
+ * // or package in usage
+ * const projectName = 'mazey';
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {void} 返回值
+ * @category Cache Data
+ */
+export declare function setSessionStorage<T>(key: string, value?: T | null): void;
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage
+ *
+ * ```
+ * setSessionStorage('test', '123');
+ * getSessionStorage('test'); // 123
+ * setLocalStorage('test', '123');
+ * getLocalStorage('test'); // 123
+ *
+ * // or package in usage
+ * const projectName = 'mazey';
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {any} 返回值
+ * @category Cache Data
+ */
+export declare function getSessionStorage<T>(key: string): T | null;
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage
+ *
+ * ```
+ * setSessionStorage('test', '123');
+ * getSessionStorage('test'); // 123
+ * setLocalStorage('test', '123');
+ * getLocalStorage('test'); // 123
+ *
+ * // or package in usage
+ * const projectName = 'mazey';
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {void} 返回值
+ * @category Cache Data
+ */
+export declare function setLocalStorage<T>(key: string, value?: T | null): void;
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage
+ *
+ * ```
+ * setSessionStorage('test', '123');
+ * getSessionStorage('test'); // 123
+ * setLocalStorage('test', '123');
+ * getLocalStorage('test'); // 123
+ *
+ * // or package in usage
+ * const projectName = 'mazey';
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {any} 返回值
+ * @category Cache Data
+ */
+export declare function getLocalStorage<T>(key: string): T | null;
+/**
+ * EN: Load a CSS file from the server.
+ *
+ * ZH: 动态加载 CSS 文件
+ *
+ * ```
+ * loadCSS(
+ *     'http://example.com/path/example.css',
+ *     {
+ *       id: 'iamid', // Optional, link ID, default none
+ *     }
+ *   )
+ *   .then(
+ *     res => {
+ *       console.log(`Load CSS Success: ${res}`);
+ *     }
+ *   )
+ *   .catch(
+ *     err => {
+ *       console.error(`Load CSS Fail: ${err.message}`)
+ *     }
+ *   );
+ * ```
+ *
+ * @param {string} url -- css资源路径
+ * @param {string} options.id -- link标签id
+ * @returns {Promise<string>} true -- 加载成功
+ * @category Load Resource
+ */
+export declare function loadCSS(url: string, options?: {
+    id?: string;
+}): Promise<unknown>;
+/**
+ * EN: Load a JavaScript file from the server and execute it.
+ *
+ * ZH: 动态加载 JavaScript 文件
+ *
+ * ```
+ * loadScript(
+ *     'http://example.com/static/js/plugin-2.1.1.min.js',
+ *     {
+ *       id: 'iamid', // (Optional) script ID, default none
+ *       timeout: 5000, // (Optional) timeout, default `5000`
+ *       isDefer: false, // (Optional) defer, default `false`
+ *     }
+ *   )
+ *   .then(
+ *     res => {
+ *       console.log(`Load JavaScript script: ${res}`);
+ *     }
+ *   )
+ *   .catch(
+ *     err => {
+ *       console.error(`Load JavaScript script: ${err.message}`)
+ *     }
+ *   );
+ * ```
+ *
+ * @param {string} url -- JavaScript 资源路径
+ * @param {string} options.id -- DOM ID
+ * @param {function} options.callback -- 加载后回调函数
+ * @param {number} options.timeout -- 超时时长
+ * @param {boolean} options.isDefer -- 是否添加 defer 标签
+ * @returns {Promise<string>} -- true 成功
+ * @category Load Resource
+ */
+export declare function loadScript(url: string, options?: {
+    id?: string;
+    callback?: (...params: UnknownFnParams) => UnknownFnReturn;
+    timeout?: number;
+    isDefer?: boolean;
+}): LoadScriptReturns;
+/**
+ * 获取时间戳
+ *
+ * @category Util
+ */
+export declare function mNow(): number;
+/**
+ * EN: Handle Cookie.
+ *
+ * ZH: 设置/获取 Cookie
+ *
+ * ```
+ * setCookie('test', '123', 30, 'example.com'); // key value day domain
+ * getCookie('test'); // 123
+ * ```
+ *
+ * @category Cache Data
+ */
+export declare function setCookie(name: string, value: string, days?: number, domain?: string): void;
+/**
+ * EN: Handle Cookie.
+ *
+ * ZH: 设置/获取 Cookie
+ *
+ * ```
+ * setCookie('test', '123', 30, 'example.com'); // key value day domain
+ * getCookie('test'); // 123
+ * ```
+ *
+ * @category Cache Data
+ */
+export declare function getCookie(name: string): string;
+/**
+ * Delete a cookie by name.
+ *
+ * @param name - The name of the cookie to delete.
+ * @returns `true` if the cookie was deleted successfully, `false` otherwise.
+ * @category Cache Data
+ */
+export declare function delCookie(name: string): boolean;
+/**
+ * @hidden
+ */
+interface WebPerformance {
+    [key: string]: string | number;
+}
+/**
+ * Gets the first contentful paint (FCP) time of a web page using the Performance API.
+ * The FCP time is the time it takes for the first piece of content to be painted on the screen.
+ *
+ * @returns A promise that resolves with the FCP time in milliseconds, or 0 if the 'paint' entry type is not supported.
+ * @category Web Performance
+ */
+export declare function getFCP(): Promise<number>;
+/**
+ * Gets the first paint (FP) time of a web page using the Performance API.
+ * The FP time is the time it takes for the first pixel to be painted on the screen.
+ *
+ * @returns A promise that resolves with the FP time in milliseconds, or 0 if the 'paint' entry type is not supported.
+ * @category Web Performance
+ */
+export declare function getFP(): Promise<number>;
+/**
+ * Gets the largest contentful paint (LCP) time of a web page using the Performance API.
+ * The LCP time is the time it takes for the largest piece of content to be painted on the screen.
+ *
+ * @returns A promise that resolves with the LCP time in milliseconds, or 0 if the 'largest-contentful-paint' entry type is not supported.
+ * @category Web Performance
+ */
+export declare function getLCP(): Promise<number>;
+/**
+ * Gets the first input delay (FID) of a web page using the Performance API.
+ * The FID is the time it takes for the first user input to be processed by the browser.
+ *
+ * @returns A promise that resolves with the FID in milliseconds, or 0 if the 'first-input' entry type is not supported.
+ * @category Web Performance
+ */
+export declare function getFID(): Promise<number>;
+/**
+ * Gets the Cumulative Layout Shift (CLS) score of a web page using the Performance API.
+ * The CLS score is a measure of how much the page layout shifts during loading.
+ *
+ * @returns A promise that resolves with the CLS score, or 0 if the 'layout-shift' entry type is not supported.
+ * @category Web Performance
+ */
+export declare function getCLS(): Promise<number>;
+/**
+ * Gets the time to first byte (TTFB) of a web page using the Performance API.
+ * The TTFB is the time it takes for the first byte of the response to be received by the browser.
+ *
+ * @returns The TTFB in milliseconds, or 0 if the navigation timing information is not available.
+ * @category Web Performance
+ */
+export declare function getTTFB(): Promise<number>;
+/**
+ * EN: Get page load time(`PerformanceNavigationTiming`).
+ *
+ * ZH: 获取页面加载相关的各项数据
+ *
+ * @remarks
+ * This function uses the [`PerformanceNavigationTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming) API to get page load time data.
+ * The `PerformanceNavigationTiming` API provides more accurate and detailed information about page load time than the deprecated [`PerformanceTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming) API.
+ * If you are using an older browser that does not support `PerformanceNavigationTiming`, you can still use the `PerformanceTiming` API by using the previous version of this library ([`v3.9.7`](https://www.npmjs.com/package/mazey/v/3.9.7)).
+ *
+ * Usage:
+ *
+ * ```
+ * // `camelCase：false` (Default) Return underline(`a_b`) data.
+ * // `camelCase：true` Return hump(`aB`) data.
+ * getPerformance()
+ *  .then(res => {
+ *   console.log(JSON.stringify(res));
+ *  })
+ *  .catch(console.error);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * {"source":"PerformanceNavigationTiming","os":"others","os_version":"","device_type":"pc","network":"4g","screen_direction":"","unload_time":0,"redirect_time":0,"dns_time":0,"tcp_time":0,"ssl_time":0,"response_time":2,"download_time":2,"first_paint_time":288,"first_contentful_paint_time":288,"dom_ready_time":0,"onload_time":0,"white_time":0,"render_time":0,"decoded_body_size":718,"encoded_body_size":718}
+ * ```
+ *
+ * Results:
+ *
+ * | Attribute | Description | Type | Values |
+ * | :------------ | :------------ | :------------ | :------------ |
+ * | dns_time | DNS Lookup | number | domainLookupEnd - domainLookupStart |
+ * | tcp_time | Connection Negotiation | number | connectEnd - connectStart |
+ * | response_time | Requests and Responses | number | responseStart - requestStart |
+ * | white_time | White Screen | number | responseStart - navigationStart |
+ * | dom_ready_time | Dom Ready | number | domContentLoadedEventStart - navigationStart |
+ * | onload_time | Onload | number | loadEventStart - navigationStart |
+ * | render_time | EventEnd | number | loadEventEnd -navigationStart |
+ * | unload_time | Unload | number | (Optional) unloadEventEnd - unloadEventStart |
+ * | redirect_time | Redirect | number | (Optional) redirectEnd - redirectStart |
+ * | ssl_time | SSL | number | (Optional) connectEnd - secureConnectionStart |
+ * | download_time | Download | number | (Optional) responseEnd - responseStart |
+ *
+ * @param {boolean} camelCase -- false（默认） 以下划线形式返回数据 true 以驼峰形式返回数据
+ * @returns {Promise<object>} 加载数据
+ * @category Web Performance
+ */
+export declare function getPerformance(camelCase?: boolean): Promise<WebPerformance | Error>;
+/**
+ * EN: Hit probability (1% ~ 100%).
+ *
+ * ZH: 百分位概率
+ *
+ * Usage:
+ *
+ * ```
+ * inRate(0.5); // 0.01 ~ 1 true/false
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * true
+ * ```
+ *
+ * Example: Test the precision.
+ *
+ * ```
+ * // Test
+ * let trueCount = 0;
+ * let falseCount = 0;
+ * new Array(1000000).fill(0).forEach(() => {
+ *   if (inRate(0.5)) {
+ *     trueCount++;
+ *   } else {
+ *     falseCount++;
+ *   }
+ * });
+ * console.log(trueCount, falseCount); // 499994 500006
+ * ```
+ *
+ * @param {number} rate -- 0.1 ~ 1 => 1% ~ 100%
+ * @returns {boolean} true 命中
+ * @category Calculate and Formula
+ */
+export declare function inRate(rate: number): boolean;
+/**
+ * EN: Detect the margin of Safety. Determine if it is a secure PWA environment that it can run.
+ *
+ * ZH: 判断是否是安全的 PWA 环境
+ *
+ * Usage:
+ *
+ * ```
+ * isSafePWAEnv();
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * true
+ * ```
+ *
+ * @returns {boolean} true 是
+ * @category Browser Information
+ */
+export declare function isSafePWAEnv(): boolean;
+/**
+ * EN: Browser Information
+ *
+ * ZH: 返回浏览器信息 https://github.com/JowayYoung/juejin-code/blob/master/browser-type.js
+ *
+ * Usage:
+ *
+ * ```
+ * getBrowserInfo();
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
+ * ```
+ *
+ * Results:
+ *
+ * | Attribute | Description | Type | Values |
+ * | :------------ | :------------ | :------------ | :------------ |
+ * | **system** | System | string | android, ios, windows, macos, linux |
+ * | systemVs | System version | string | windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 <br />macos: ... |
+ * | platform | Platform | string | desktop, mobile |
+ * | engine | Engine | string | webkit, gecko, presto, trident |
+ * | engineVs | Engine version | string | - |
+ * | supporter | Supporter | string | edge, opera, chrome, safari, firefox, iexplore |
+ * | supporterVs | Supporter version | string | - |
+ * | shell | Shell | string | (Optional) wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
+ * | shellVs | Shell version | string | (Optional) 20/... |
+ * | appleType | Apple device type | string | (Optional) ipad, iphone, ipod, iwatch |
+ *
+ * Example: Determine the environment of the mobile QQ.
+ *
+ * ```
+ * const { system, shell } = getBrowserInfo();
+ * const isMobileQQ = ['android', 'ios'].includes(system) && ['qq_browser', 'qq_app'].includes(shell);
+ * ```
+ *
+ * @returns 浏览器信息
+ * @category Browser Information
+ */
+export declare function getBrowserInfo(): BrowserInfo;
+/**
+ * 去除 HTML 标签
+ *
+ * @param {string} str 带html标签的字符串
+ * @returns {string} 字符串
+ * @category Util
+ */
+export declare function clearHtml(str: string, options?: {
+    removeNewLine?: boolean;
+}): string;
+/**
+ * Sanitizes user input to prevent XSS attacks
+ *
+ * @param input - The input string to sanitize
+ * @returns The sanitized input string
+ * @category Util
+ */
+export declare function sanitizeInput(input: string): string;
+/**
+ * Reverses the sanitization done by the `sanitizeInput` function.
+ *
+ * @param input - The input string to unsanitize
+ * @returns The unsanitized input string
+ * @category Util
+ */
+export declare function unsanitize(input: string): string;
+/**
+ * 截取字符串，中文算 2 个字节
+ *
+ * @param {string} str 要截取的字符串
+ * @param {number} len
+ * @param {boolean} hasDot
+ * @returns {string} 返回截取后的字符串
+ * @category Util
+ */
+export declare function truncateZHString(str: string, len: number, hasDot?: boolean): string;
+/**
+ * Alias of `truncateZHString`
+ *
+ * @hidden
+ */
+export declare function cutCHSString(str: string, len: number, hasDot?: boolean): string;
+/**
+ * EN: Check whether the page is loaded successfully (Keep the compatibility if the browser's `load` event has been triggered).
+ *
+ * ZH: 页面加载完成
+ *
+ * ```
+ * windowLoaded(30) // second
+ *   .then(res => {
+ *     console.log(`Load Success: ${res}`); // Load Success: load
+ *   })
+ *   .catch(err => {
+ *     console.log(`Load Timeout or Fail: ${err.message}`);
+ *   });
+ * ```
+ *
+ * @param {number} timeout 超时时间 / 单位：秒
+ * @returns {Promise<string>} document is loaded? 'complete' 'load' / 'timeout'
+ * @category Load Resource
+ */
+export declare function windowLoaded(timeout?: number): Promise<string | Error>;
+/**
+ * EN: Add `<style>` in `<head>`.
+ *
+ * ZH: 添加样式标签; style: 样式标签内的字符串; id: `<style>` 标签的 `id`; 返回: 添加成功/失败
+ *
+ * Example 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
+ *
+ * ```
+ * addStyle(
+ *   `
+ *     body {
+ *       background-color: #333;
+ *     }
+ *   `,
+ *   {
+ *     id: 'test',
+ *   }
+ * );
+ * // <style id="test">
+ * //   body {
+ * //     background-color: #333;
+ * //   }
+ * // </style>
+ * ```
+ *
+ * Example 2: Add the `<style>` without `id`, and repeated invoking will add a new one.
+ *
+ * ```
+ * addStyle(
+ *   `
+ *     body {
+ *       background-color: #444;
+ *     }
+ *   `
+ * );
+ * // <style>
+ * //   body {
+ * //     background-color: #444;
+ * //   }
+ * // </style>
+ * ```
+ *
+ * @category DOM
+ */
+export declare function addStyle(style: string, options?: {
+    id?: string;
+}): boolean;
+/**
+ * EN: Custom console printing (`console`).
+ *
+ * ZH: 生成自定义控制台打印
+ *
+ * Usage:
+ *
+ * ```
+ * const myConsole = genCustomConsole('MazeyLog:');
+ * myConsole.log('I am string.');
+ * myConsole.info('I am boolean.', true);
+ * myConsole.info('I am number.', 123, 456);
+ * myConsole.info('I am object.', { a: 123, b: 456});
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * MazeyLog: I am string.
+ * MazeyLog: I am boolean. true
+ * MazeyLog: I am number. 123 456
+ * MazeyLog: I am object. {a: 123, b: 456}
+ * ```
+ *
+ * @param {string} prefix 前缀
+ * @param {string} locales A locale string.
+ * @param {function} logFn The function with Log.
+ * @param {function} errorFn The function with Error.
+ * @returns {object} 新实例
+ * @category Debug
+ */
+export declare function genCustomConsole(prefix?: string, options?: {
+    isClosed?: boolean;
+    showWrap?: boolean;
+    showDate?: boolean;
+    locales?: string;
+    logFn?: () => void;
+    errorFn?: () => void;
+}): Console;
+/**
+ * Verify the validity of axios response.
+ *
+ * Reference: [Handling Errors](https://axios-http.com/docs/handling_errors)
+ *
+ * @category Util
+ * @hidden
+ */
+export declare function zAxiosIsValidRes(res: ZResResponse | undefined, options?: ZResIsValidResOptions): boolean;
+/**
+ * Verify the validity of a non-empty array.
+ *
+ * @category Util
+ */
+export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
+/**
+ * Determine the validity of the data.
+ *
+ * Usage:
+ *
+ * ```
+ * const validData = {
+ *   a: {
+ *     b: {
+ *       c: 413
+ *     }
+ *   }
+ * };
+ *
+ * const isValidDataResA = isValidData(validData, ['a', 'b', 'c'], 2333);
+ * const isValidDataResB = isValidData(validData, ['a', 'b', 'c'], 413);
+ * const isValidDataResC = isValidData(validData, ['d', 'd'], 413);
+ *
+ * console.log('isValidDataResA:', isValidDataResA);
+ * console.log('isValidDataResB:', isValidDataResB);
+ * console.log('isValidDataResC:', isValidDataResC);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * isValidDataResA: false
+ * isValidDataResB: true
+ * isValidDataResC: false
+ * ```
+ *
+ * @param {any} data Original Data
+ * @param {string[]} attributes Data Attributes
+ * @param {any} validValue Given Value for verifying.
+ * @returns {boolean} Return TRUE if the data is valid.
+ * @category Util
+ */
+export declare function isValidData(data: UnknownObject, attributes: string[], validValue: SimpleType): boolean;
+/**
+ * 语义化文件大小, 把字节转换成正常文件大小.
+ *
+ * @category Util
+ */
+export declare function getFileSize(size: number): string;
+/**
+ * Detect webp support.
+ *
+ * Reference: [Detect WEBP Support with JavaScript](https://davidwalsh.name/detect-webp)
+ *
+ * @category Browser Information
+ */
+export declare function isSupportWebp(): Promise<boolean>;
+/**
+ * Generate a Hash Code from a string.
+ *
+ * Reference: [Generate a Hash from string in Javascript](https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery)
+ *
+ * @category Util
+ */
+export declare function genHashCode(str: string): number;
+/**
+ * Return the formatted date string in the given format.
+ *
+ * Usage:
+ *
+ * ```
+ * console.log('Default formatDate value:', formatDate());
+ * console.log('String formatDate value:', formatDate('Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)', 'yyyy-MM-dd hh:mm:ss'));
+ * console.log('Number formatDate value:', formatDate(1641881235000, 'yyyy-MM-dd hh:mm:ss'));
+ * console.log('Date formatDate value:', formatDate(new Date(2014, 1, 11), 'MM/dd/yyyy'));
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * Default formatDate value: 2023-01-11
+ * String formatDate value: 2022-01-11 14:12:26
+ * Number formatDate value: 2022-01-11 14:07:15
+ * Date formatDate value: 02/11/2014
+ * ```
+ *
+ * @param {Date|number|string} dateIns Original Date
+ * @param {string} format Format String
+ * @returns {string} Return the formatted date string.
+ * @category Util
+ */
+export declare function formatDate(dateIns?: Date | number | string, format?: string): string;
+/**
+ * Get event container.
+ *
+ * @category Event
+ * @hidden
+ */
+export declare function getDefineListeners(): DefineListeners;
+/**
+ * Add event.
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+export declare function addEvent(type: string, fn: UnknownFn): void;
+/**
+ * Invoke event.
+ *
+ * @param type
+ * @category Event
+ */
+export declare function invokeEvent(type: string): void;
+/**
+ * Remove event.
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+export declare function removeEvent(type: string, fn: UnknownFn): void;
+/**
+ * Checks if the given string is a valid URL, including **scheme URLs**.
+ *
+ * @example
+ * ```js
+ * isValidUrl('https://www.example.com'); // true
+ * isValidUrl('http://example.com/path/exx/ss'); // true
+ * isValidUrl('https://www.example.com/?q=hello&age=24#world'); // true
+ * isValidUrl('http://www.example.com/#world?id=9'); // true
+ * isValidUrl('ftp://example.com'); // true
+ * ```
+ *
+ * @remarks
+ * If you are specifically checking for HTTP/HTTPS URLs, it is recommended to use the `isValidHttpUrl` function instead.
+ * The `isValidUrl` function matches all scheme URLs, including FTP and other non-HTTP schemes.
+ *
+ * @param url - The URL to check.
+ * @returns Returns `true` if the given string is a valid URL, else `false`.
+ * @category URL
+ */
+export declare function isValidUrl(url: string): boolean;
+/**
+ * Check if the given string is a valid HTTP/HTTPS URL.
+ *
+ * @example
+ * ```js
+ * isValidHttpUrl('https://www.example.com'); // true
+ * isValidHttpUrl('http://example.com/path/exx/ss'); // true
+ * isValidHttpUrl('https://www.example.com/?q=hello&age=24#world'); // true
+ * isValidHttpUrl('http://www.example.com/#world?id=9'); // true
+ * isValidHttpUrl('ftp://example.com'); // false
+ * ```
+ *
+ * @param url
+ * @returns {boolean} Return true if the given string is a valid HTTP/HTTPS URL.
+ * @category URL
+ */
+export declare function isValidHttpUrl(url: string): boolean;
+/**
+ * Check if the given string is a mobile phone number.
+ *
+ * @example
+ * ```js
+ * console.log(isMobile('13800138000')); // true
+ * console.log(isMobile('1380013800')); // false
+ * console.log(isMobile('138001380000')); // false
+ * console.log(isMobile('1380013800a')); // false
+ * ```
+ *
+ * @param mobile
+ * @returns {boolean} Return true if the given string is a mobile phone number.
+ * @category Util
+ */
+export declare function isValidPhoneNumber(mobile: string): boolean;
+/**
+ * Check if the given string is a valid email.
+ *
+ * @example
+ * ```js
+ * console.log(isValidEmail('mazeyqian@gmail.com')); // true
+ * ```
+ *
+ * @param email
+ * @returns {boolean} Return true if the given string is a valid email.
+ * @category Util
+ */
+export declare function isValidEmail(email: string): boolean;
+/**
+ * Convert a given 10-hex number to a lowercase 26-hex string.
+ *
+ * @example
+ * ```js
+ * console.log(convert10To26(1)); // a
+ * console.log(convert10To26(26)); // z
+ * console.log(convert10To26(27)); // aa
+ * console.log(convert10To26(52)); // az
+ * console.log(convert10To26(53)); // ba
+ * ```
+ *
+ * @param {number} num
+ * @returns {string} Return a lowercase 26-hex string.
+ * @category Util
+ */
+export declare function convert10To26(num: number): string;
+/**
+ * EN: Get the file type of the url.
+ *
+ * ZH: 获取文件后缀名
+ *
+ * @example
+ * ```js
+ * console.log(getUrlFileType('https://example.com/a/b/c.png')); // png
+ * console.log(getUrlFileType('https://example.com/a/b/c.jpg')); // jpg
+ * console.log(getUrlFileType('https://example.com/a/b/c.jpeg')); // jpeg
+ * console.log(getUrlFileType('/a/b/c.jpeg')); // jpeg
+ * console.log(getUrlFileType('https://example.com/a/b/c.v/a')); // ''
+ * ```
+ *
+ * @param url
+ * @returns
+ * @category URL
+ */
+export declare function getUrlFileType(url: string): boolean | string;
+/**
+ * Sets the width and height of all images on the page based on their `src` attribute.
+ * The `src` attribute should contain `width` and/or `height` values in the format "width=100" or "height=100".
+ * If jQuery is available, this function uses jQuery to select the images. Otherwise, it uses pure JavaScript.
+ *
+ * @example
+ * ```
+ * // Example images with `src` attributes containing `width` and/or `height` values
+ * const img1 = document.createElement('img');
+ * img1.setAttribute('src', 'https://example.com/example.png?width=2233&height=111');
+ * document.body.appendChild(img1);
+ *
+ * const img2 = document.createElement('img');
+ * img2.setAttribute('src', 'https://example.com/example.png?width=100%&height=auto');
+ * document.body.appendChild(img2);
+ * ```
+ *
+ * @returns {boolean} - Returns `true` if images were found and their dimensions were set, otherwise `false`.
+ * @category DOM
+ */
+export declare function setImgWidHeiBySrc(): boolean;
+/**
+ * Generate the inline style string from the given parameters. The first parameter is the query selector, and the second parameter is the style array.
+ *
+ * @example
+ * ```js
+ * console.log(genStyleString('.a', [ 'color:red' ])); // '.a{color:red;}'
+ * console.log(genStyleString('#b', [ 'color:red', 'font-size:12px' ])); // '#b{color:red;font-size:12px;}'
+ * ```
+ *
+ * @param {string} selector
+ * @param {array} styleArray
+ * @returns {string} The inline style string.
+ * @category DOM
+ */
+export declare function genStyleString(selector: string, styleArray: Array<string>): string;
+/**
+ * Load an image from the given URL.
+ *
+ * The target image will be loaded in the background, and the Promise status will change after the image is loaded. If the image fails to load, the Promise status will change to `reject` with the error object. If the image is loaded successfully, the Promise status will change to `resolve` with the image object. This method can be used to preload images and cache them in the browser. It can also be used to implement lazy loading of images.
+ *
+ * Note that this method will not add the image to the DOM.
+ *
+ * @example
+ * ```js
+ * loadImage('https://example.com/example.png')
+ *   .then((img) => {
+ *     console.log(img);
+ *   })
+ *   .catch((err) => {
+ *     console.log(err);
+ *   });
+ * ```
+ *
+ * @param {string} url - The URL of the image to load.
+ * @returns {Promise} A Promise that resolves with the loaded image or rejects with an error.
+ * @category Load Resource
+ */
+export declare function loadImage(url: string): Promise<HTMLImageElement>;
+/**
+ * Get the current version.
+ *
+ * @hidden
+ */
+export declare function getCurrentVersion(): string;
+/**
+ * Repeatedly fires a callback function with a certain interval until a specified condition is met.
+ *
+ * @param callback The callback function to fire.
+ * @param options An object containing the options for the function.
+ * @param options.interval The interval between each firing of the callback function, in milliseconds. Defaults to 1000.
+ * @param options.times The maximum number of times to fire the callback function. Defaults to 10.
+ * @param options.context The context to use when calling the callback function. Defaults to null.
+ * @param options.args An array of arguments to pass to the callback function.
+ * @param condition A function that takes the result of the callback function as its argument and returns a boolean value indicating whether the condition has been met. Defaults to a function that always returns true.
+ * @category Util
+ */
+export declare function repeatUntilConditionMet<T extends (...args: UnknownFnParams) => UnknownFnReturn>(callback: T, options?: RepeatUntilOptions, condition?: (result: ReturnType<T>) => boolean): void;
+/**
+ * Load a script from the given URL if it (`window['attribute']`) has not already been loaded.
+ *
+ * @example
+ * ```js
+ * loadScriptIfUndefined('jQuery', 'https://example.com/lib/jquery.min.js')
+ *   .then(() => {
+ *     console.log('jQuery is loaded.');
+ *   })
+ *   .catch(err => {
+ *     console.log('Failed to load jQuery.', err);
+ *   });
+ * ```
+ *
+ * @param {string} windowAttribute - The name of the window attribute to check (e.g. `jQuery`, `axios`, etc.).
+ * @param {string} url - The URL of the script to load.
+ * @returns {Promise} A Promise that resolves when the script has been loaded.
+ * @category Load Resource
+ */
+export declare function loadScriptIfUndefined(windowAttribute: string, url: string): LoadScriptReturns;
+/**
+ * Retrieve a query parameter from a script URL in the browser.
+ *
+ * @param param - The name of the query parameter to retrieve.
+ * @param matchString - An optional substring to match in the script URL.
+ *                      If not provided, defaults to matching the ".js" substring.
+ * @returns The decoded value of the specified query parameter, or an empty string if no matching parameter is found.
+ * @category URL
+ */
+export declare function getScriptQueryParam(param: string, matchString?: string): string;
+/**
+ * Wait for a specified amount of time.
+ *
+ * @param time The amount of time to wait, in milliseconds.
+ * @returns A Promise that resolves after the specified time has elapsed.
+ * @category Util
+ */
+export declare function waitTime(time: number): Promise<number>;
+export {};
 //# sourceMappingURL=index.d.ts.map