mazey 3.11.1 → 3.11.2

package/lib/index.d.ts

@@ -9,13 +9,14 @@ import { BrowserInfo, DefineListeners, ThrottleFunc, DebounceFunc, IsNumberOptio
  *
  * Usage:
  *
- * ```
- * longestComSubstring('fish', 'finish');
+ * ```javascript
+ * const ret = longestComSubstring('fish', 'finish');
+ * console.log(ret);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * 3
  * ```
  *
@@ -38,13 +39,14 @@ export declare function calLongestCommonSubstring(aStr: string, bStr: string): n
  *
  * Usage:
  *
- * ```
- * longestComSubsequence('fish', 'finish');
+ * ```javascript
+ * const ret = longestComSubsequence('fish', 'finish');
+ * console.log(ret);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * 4
  * ```
  *
@@ -63,11 +65,20 @@ export declare function calLongestCommonSubsequence(aStr: string, bStr: string):
 /**
  * Get the query param's value of the current Web URL(`location.search`).
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * // 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
+ * const p1 = getQueryParam('t3');
+ * const p2 = getQueryParam('t4');
+ * console.log(p1, p2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3 4
  * ```
  *
  * @param {string} param Query param.
@@ -78,10 +89,18 @@ export declare function getQueryParam(param: string): string;
 /**
  * Returns the value of the specified query parameter in the input URL.
  *
- * @example
+ * Usage:
+ *
+ * ```javascript
+ * const p1 = getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3');
+ * const p2 = getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4');
+ * console.log(p1, p2);
  * ```
- * 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'
+ *
+ * Output:
+ *
+ * ```text
+ * 3 4
  * ```
  *
  * @param {string} url The URL string.
@@ -95,14 +114,16 @@ export declare function getUrlParam(url: string, param: string): string | string
  *
  * 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');
+ * ```javascript
+ * const ret1 = updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three');
+ * const ret2 = updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * http://example.com/?t1=1&t2=2&t3=three&t4=4
  * http://example.com/?t1=1&t2=2&t3=3&t4=four
  * ```
@@ -119,18 +140,18 @@ export declare function updateQueryParam(url: string, param: string, value: stri
  *
  * Usage:
  *
- * ```
+ * ```javascript
  * // 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');
+ * const p1 = getHashQueryParam('t3');
+ * const p2 = getHashQueryParam('t4');
+ * console.log(p1, p2);
  * ```
  *
  * Output:
  *
- * ```
- * 3
- * 4
+ * ```text
+ * 3 4
  * ```
  *
  * @param {string} param Query param.
@@ -143,18 +164,24 @@ export declare function getHashQueryParam(param: string): string;
  *
  * 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']);
+ * ```javascript
+ * const ret1 = getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
+ * const ret2 = getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
+ * const ret3 = getDomain('http://example.com:7890/test/thanks', ['hostname']);
+ * const ret4 = getDomain('http://example.com:7890/test/thanks', ['host']); // With Port
+ * const ret5 = getDomain('http://example.com:7890/test/thanks', ['origin']);
+ * const ret6 = getDomain('http://example.com:7890/test/thanks?id=1', ['origin', 'pathname', 'search']);
+ * console.log(ret1);
+ * console.log(ret2);
+ * console.log(ret3);
+ * console.log(ret4);
+ * console.log(ret5);
+ * console.log(ret6);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * example.com
  * example.com/test/thanks
  * example.com
@@ -171,9 +198,20 @@ export declare function getDomain(url: string, rules?: string[]): string;
 /**
  * Transfer CamelCase to KebabCase.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = convertCamelToKebab('ABC');
+ * const ret2 = convertCamelToKebab('aBC');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
- * convertCamelToKebab('ABC'); // a-b-c
- * convertCamelToKebab('aBC'); // a-b-c
+ *
+ * Output:
+ *
+ * ```text
+ * a-b-c
+ * a-b-c
  * ```
  *
  * @param {string} camelCase 'aBC' or 'ABC'
@@ -190,9 +228,20 @@ export declare function camelCaseToKebabCase(camelCase: string): string;
 /**
  * Transfer CamelCase to Underscore.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = convertCamelToUnder('ABC');
+ * const ret2 = convertCamelToUnder('aBC');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
- * convertCamelToUnder('ABC'); // a_b_c
- * convertCamelToUnder('aBC'); // a_b_c
+ *
+ * Output:
+ *
+ * ```text
+ * a_b_c
+ * a_b_c
  * ```
  *
  * @param {string} camelCase 'aBC' or 'ABC'
@@ -211,9 +260,20 @@ export declare function camelCase2Underscore(camelCase: string): string;
  *
  * Note: This method is used to replace the native `String.prototype.trim()`. But it is not necessary to use it in modern browsers.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = mTrim(' 1 2 3 ');
+ * const ret2 = mTrim('abc ');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
- * mTrim(' 1 2 3 '); // '1 2 3'
- * mTrim('abc '); // 'abc'
+ *
+ * Output:
+ *
+ * ```text
+ * 1 2 3
+ * abc
  * ```
  *
  * @param {string} str The string to trim.
@@ -225,9 +285,20 @@ export declare function mTrim(str: string): string;
 /**
  * Make a new line of HTML.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = newLine('a\nb\nc');
+ * const ret2 = newLine('a\n\nbc');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
- * newLine('a\nb\nc'); // 'a<br />b<br />c'
- * newLine('a\n\nbc'); // 'a<br /><br />bc'
+ *
+ * Output:
+ *
+ * ```text
+ * a<br />b<br />c
+ * a<br /><br />bc
  * ```
  *
  * @param {string} str The string to make a new line.
@@ -240,16 +311,18 @@ export declare function newLine(str: string): string;
  *
  * Usage:
  *
- * ```
- * deepCopy(['a', 'b', 'c']);
- * deepCopy('abc');
+ * ```javascript
+ * const ret1 = deepCopy(['a', 'b', 'c']);
+ * const ret2 = deepCopy('abc');
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * ['a', 'b', 'c']
- * 'abc'
+ * abc
  * ```
  *
  * @param {object} obj The value to clone.
@@ -268,14 +341,16 @@ export declare function deepCopyObject<T>(obj: T): T;
  *
  * Usage:
  *
- * ```
- * isJSONString(`['a', 'b', 'c']`);
- * isJSONString(`["a", "b", "c"]`);
+ * ```javascript
+ * const ret1 = isJSONString(`['a', 'b', 'c']`);
+ * const ret2 = isJSONString(`["a", "b", "c"]`);
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * false
  * true
  * ```
@@ -294,9 +369,20 @@ export declare function isJsonString(str: string): boolean;
 /**
  * Produce a random string of number, `genRndNumString(7)` => '7658495'.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = genRndNumString(4);
+ * const ret2 = genRndNumString(7);
+ * console.log(ret1);
+ * console.log(ret2);
  * ```
- * genRndNumString(4); // '9730'
- * genRndNumString(7); // '2262490'
+ *
+ * Output:
+ *
+ * ```text
+ * 9730
+ * 2262490
  * ```
  *
  * @param {number} n Length
@@ -311,7 +397,23 @@ export declare function genRndNumString(n?: number): string;
  */
 export declare function generateRndNum(n?: number): string;
 /**
- * 根据时间生成唯一标志的数字 genUniqueNumString() => 1538324722364123
+ * 根据时间生成唯一标志的数字 `genUniqueNumString()` => `1538324722364123`
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = genUniqueNumString();
+ * const ret2 = genUniqueNumString(3);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1538324722364123
+ * 1538324722364123
+ * ```
  *
  * @param {number} n 随机数的长度
  * @category Util
@@ -326,6 +428,22 @@ export declare function generateUniqueNum(n?: number): string;
 /**
  * 浮点数转为百分比 0.2 => 20%
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = floatToPercent(0.2);
+ * const ret2 = floatToPercent(0.2, 2);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 20%
+ * 20.00%
+ * ```
+ *
  * @param {number} num 浮点数
  * @param {number} fixSize 保留几位浮点数
  * @category Util
@@ -334,19 +452,43 @@ export declare function floatToPercent(num: number, fixSize?: number): string;
 /**
  * 浮点数保留指定位
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = floatFixed(0.2);
+ * const ret2 = floatFixed(0.2, 2);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 0
+ * 0.20
+ * ```
+ *
  * @category Util
  */
 export declare function floatFixed(num: string, size?: number): string;
 /**
  * 阻止冒泡
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = cancelBubble(e);
+ * ```
+ *
  * @category Event
  */
 export declare function cancelBubble(e: Event): void;
 /**
  * Modify `class`.
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * const dom = document.querySelector('#box');
  *
  * // Determine `class`
@@ -363,7 +505,9 @@ export declare function hasClass(obj: HTMLElement, cls: string): boolean;
 /**
  * Modify `class`.
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * const dom = document.querySelector('#box');
  *
  * // Determine `class`
@@ -380,7 +524,9 @@ export declare function addClass(obj: HTMLElement, cls: string): void;
 /**
  * Modify `class`.
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * const dom = document.querySelector('#box');
  *
  * // Determine `class`
@@ -399,7 +545,9 @@ export declare function removeClass(obj: HTMLElement, cls: string): void;
  *
  * ZH: 节流
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * const foo = throttle(() => {
  *   console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
  * }, 1000, { leading: true });
@@ -418,7 +566,9 @@ export declare function throttle<T extends (...args: UnknownFnParams) => Unknown
  *
  * ZH: 去抖
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * 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);
@@ -430,11 +580,23 @@ export declare function debounce<T extends (...args: UnknownFnParams) => Unknown
 /**
  * 获取间隔时间
  *
- * @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 秒
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = getFriendlyInterval(new Date('2020-03-28 00:09:27'), new Date('2023-04-18 10:54:00'), { type: 'd' });
+ * const ret2 = getFriendlyInterval(1585325367000, 1681786440000, { type: 'text' });
+ * const ret3 = getFriendlyInterval('2020-03-28 00:09:27', '2023-04-18 10:54:00', { type: 'text' });
+ * console.log(ret1);
+ * console.log(ret2);
+ * console.log(ret3);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1116
+ * 1116 天 10 时 44 分 33 秒
+ * 1116 天 10 时 44 分 33 秒
  * ```
  *
  * @param {number/Date} start 开始时间戳 1585325367122
@@ -451,14 +613,23 @@ export declare function getFriendlyInterval(start?: number | string | Date, end?
  *
  * ZH: 判断是否有效数字
  *
- * ```
- * isNumber(123); // true
- * isNumber('123'); // false
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = isNumber(123);
+ * const ret2 = isNumber('123');
  * // Default: NaN, Infinity is not Number
- * isNumber(Infinity); // false
- * isNumber(Infinity, { isInfinityAsNumber: true }); // true
- * isNumber(NaN); // false
- * isNumber(NaN, { isNaNAsNumber: true, isInfinityAsNumber: true }); // true
+ * const ret3 = isNumber(Infinity);
+ * const ret4 = isNumber(Infinity, { isInfinityAsNumber: true });
+ * const ret5 = isNumber(NaN);
+ * const ret6 = isNumber(NaN, { isNaNAsNumber: true, isInfinityAsNumber: true });
+ * console.log(ret1, ret2, ret3, ret4, ret5, ret6);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false true false true
  * ```
  *
  * @param {*} num 被判断的值
@@ -471,6 +642,14 @@ export declare function isNumber(num: unknown, options?: IsNumberOptions): boole
 /**
  * 执行有效函数
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = doFn(() => {
+ *  console.log('doFn');
+ * });
+ * ```
+ *
  * @param {function} fn 等待被执行的未知是否有效的函数
  * @category Util
  */
@@ -480,11 +659,14 @@ export declare function doFn(fn: AnyFunction, ...params: Parameters<AnyFunction>
  *
  * ZH: 存储/获取数据到 sessionStorage/localStorage
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
+ * const ret1 = getSessionStorage('test');
  * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
+ * const ret2 = getLocalStorage('test');
+ * console.log(ret1, ret2);
  *
  * // or package in usage
  * const projectName = 'mazey';
@@ -497,6 +679,12 @@ export declare function doFn(fn: AnyFunction, ...params: Parameters<AnyFunction>
  * }
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
  * @param {string} key 键
  * @returns {void} 返回值
  * @category Cache Data
@@ -507,11 +695,14 @@ export declare function setSessionStorage<T>(key: string, value?: T | null): voi
  *
  * ZH: 存储/获取数据到 sessionStorage/localStorage
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
+ * const ret1 = getSessionStorage('test');
  * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
+ * const ret2 = getLocalStorage('test');
+ * console.log(ret1, ret2);
  *
  * // or package in usage
  * const projectName = 'mazey';
@@ -524,6 +715,12 @@ export declare function setSessionStorage<T>(key: string, value?: T | null): voi
  * }
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
  * @param {string} key 键
  * @returns {any} 返回值
  * @category Cache Data
@@ -534,11 +731,14 @@ export declare function getSessionStorage<T>(key: string): T | null;
  *
  * ZH: 存储/获取数据到 sessionStorage/localStorage
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
+ * const ret1 = getSessionStorage('test');
  * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
+ * const ret2 = getLocalStorage('test');
+ * console.log(ret1, ret2);
  *
  * // or package in usage
  * const projectName = 'mazey';
@@ -551,6 +751,12 @@ export declare function getSessionStorage<T>(key: string): T | null;
  * }
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
  * @param {string} key 键
  * @returns {void} 返回值
  * @category Cache Data
@@ -561,11 +767,14 @@ export declare function setLocalStorage<T>(key: string, value?: T | null): void;
  *
  * ZH: 存储/获取数据到 sessionStorage/localStorage
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setSessionStorage('test', '123');
- * getSessionStorage('test'); // 123
+ * const ret1 = getSessionStorage('test');
  * setLocalStorage('test', '123');
- * getLocalStorage('test'); // 123
+ * const ret2 = getLocalStorage('test');
+ * console.log(ret1, ret2);
  *
  * // or package in usage
  * const projectName = 'mazey';
@@ -578,8 +787,14 @@ export declare function setLocalStorage<T>(key: string, value?: T | null): void;
  * }
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
  * @param {string} key 键
- * @returns {any} 返回值
+ * @returns {void} 返回值
  * @category Cache Data
  */
 export declare function getLocalStorage<T>(key: string): T | null;
@@ -588,7 +803,9 @@ export declare function getLocalStorage<T>(key: string): T | null;
  *
  * ZH: 动态加载 CSS 文件
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * loadCSS(
  *     'http://example.com/path/example.css',
  *     {
@@ -607,6 +824,12 @@ export declare function getLocalStorage<T>(key: string): T | null;
  *   );
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * Load CSS Success: loaded
+ * ```
+ *
  * @param {string} url -- css资源路径
  * @param {string} options.id -- link标签id
  * @returns {Promise<string>} true -- 加载成功
@@ -620,7 +843,9 @@ export declare function loadCSS(url: string, options?: {
  *
  * ZH: 动态加载 JavaScript 文件
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * loadScript(
  *     'http://example.com/static/js/plugin-2.1.1.min.js',
  *     {
@@ -641,6 +866,12 @@ export declare function loadCSS(url: string, options?: {
  *   );
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * Load JavaScript script: loaded
+ * ```
+ *
  * @param {string} url -- JavaScript 资源路径
  * @param {string} options.id -- DOM ID
  * @param {function} options.callback -- 加载后回调函数
@@ -658,6 +889,19 @@ export declare function loadScript(url: string, options?: {
 /**
  * 获取时间戳
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = mNow();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1585325367122
+ * ```
+ *
  * @category Util
  */
 export declare function mNow(): number;
@@ -666,9 +910,18 @@ export declare function mNow(): number;
  *
  * ZH: 设置/获取 Cookie
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setCookie('test', '123', 30, 'example.com'); // key value day domain
- * getCookie('test'); // 123
+ * const ret = getCookie('test');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123
  * ```
  *
  * @category Cache Data
@@ -679,9 +932,18 @@ export declare function setCookie(name: string, value: string, days?: number, do
  *
  * ZH: 设置/获取 Cookie
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * setCookie('test', '123', 30, 'example.com'); // key value day domain
- * getCookie('test'); // 123
+ * const ret = getCookie('test');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123
  * ```
  *
  * @category Cache Data
@@ -690,6 +952,19 @@ export declare function getCookie(name: string): string;
 /**
  * Delete a cookie by name.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = delCookie('test');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
  * @param name - The name of the cookie to delete.
  * @returns `true` if the cookie was deleted successfully, `false` otherwise.
  * @category Cache Data
@@ -705,6 +980,22 @@ interface WebPerformance {
  * 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getFCP().then(
+ *  res => {
+ *   console.log(`FCP: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * FCP: 123
+ * ```
+ *
  * @returns A promise that resolves with the FCP time in milliseconds, or 0 if the 'paint' entry type is not supported.
  * @category Web Performance
  */
@@ -713,6 +1004,22 @@ 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getFP().then(
+ *  res => {
+ *    console.log(`FP: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * FP: 123
+ * ```
+ *
  * @returns A promise that resolves with the FP time in milliseconds, or 0 if the 'paint' entry type is not supported.
  * @category Web Performance
  */
@@ -721,6 +1028,22 @@ 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getLCP().then(
+ *  res => {
+ *    console.log(`LCP: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * LCP: 123
+ * ```
+ *
  * @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
  */
@@ -729,6 +1052,22 @@ 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getFID().then(
+ *  res => {
+ *    console.log(`FID: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * FID: 123
+ * ```
+ *
  * @returns A promise that resolves with the FID in milliseconds, or 0 if the 'first-input' entry type is not supported.
  * @category Web Performance
  */
@@ -737,6 +1076,22 @@ 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getCLS().then(
+ *  res => {
+ *    console.log(`CLS: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * CLS: 123
+ * ```
+ *
  * @returns A promise that resolves with the CLS score, or 0 if the 'layout-shift' entry type is not supported.
  * @category Web Performance
  */
@@ -745,6 +1100,22 @@ 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.
  *
+ * Usage:
+ *
+ * ```javascript
+ * getTTFB().then(
+ *  res => {
+ *    console.log(`TTFB: ${res}`);
+ *  }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * TTFB: 123
+ * ```
+ *
  * @returns The TTFB in milliseconds, or 0 if the navigation timing information is not available.
  * @category Web Performance
  */
@@ -761,7 +1132,7 @@ export declare function getTTFB(): Promise<number>;
  *
  * Usage:
  *
- * ```
+ * ```javascript
  * // `camelCase：false` (Default) Return underline(`a_b`) data.
  * // `camelCase：true` Return hump(`aB`) data.
  * getPerformance()
@@ -773,7 +1144,7 @@ export declare function getTTFB(): Promise<number>;
  *
  * Output:
  *
- * ```
+ * ```text
  * {"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}
  * ```
  *
@@ -805,19 +1176,20 @@ export declare function getPerformance(camelCase?: boolean): Promise<WebPerforma
  *
  * Usage:
  *
- * ```
- * inRate(0.5); // 0.01 ~ 1 true/false
+ * ```javascript
+ * const ret = inRate(0.5); // 0.01 ~ 1 true/false
+ * console.log(ret);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * true
  * ```
  *
  * Example: Test the precision.
  *
- * ```
+ * ```javascript
  * // Test
  * let trueCount = 0;
  * let falseCount = 0;
@@ -843,13 +1215,14 @@ export declare function inRate(rate: number): boolean;
  *
  * Usage:
  *
- * ```
- * isSafePWAEnv();
+ * ```javascript
+ * const ret = isSafePWAEnv();
+ * console.log(ret);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * true
  * ```
  *
@@ -864,13 +1237,14 @@ export declare function isSafePWAEnv(): boolean;
  *
  * Usage:
  *
- * ```
- * getBrowserInfo();
+ * ```javascript
+ * const ret = getBrowserInfo();
+ * console.log(ret);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
  * ```
  *
@@ -879,7 +1253,7 @@ export declare function isSafePWAEnv(): boolean;
  * | 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: ... |
+ * | systemVs | System version | string | Windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 macOS: ... |
  * | platform | Platform | string | desktop, mobile |
  * | engine | Engine | string | webkit, gecko, presto, trident |
  * | engineVs | Engine version | string | - |
@@ -891,7 +1265,7 @@ export declare function isSafePWAEnv(): boolean;
  *
  * Example: Determine the environment of the mobile QQ.
  *
- * ```
+ * ```javascript
  * const { system, shell } = getBrowserInfo();
  * const isMobileQQ = ['android', 'ios'].includes(system) && ['qq_browser', 'qq_app'].includes(shell);
  * ```
@@ -903,6 +1277,19 @@ export declare function getBrowserInfo(): BrowserInfo;
 /**
  * 去除 HTML 标签
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = clearHtml('<div>hello world</div>');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello world
+ * ```
+ *
  * @param {string} str 带html标签的字符串
  * @returns {string} 字符串
  * @category Util
@@ -911,7 +1298,20 @@ export declare function clearHtml(str: string, options?: {
     removeNewLine?: boolean;
 }): string;
 /**
- * Sanitizes user input to prevent XSS attacks
+ * Sanitizes user input to prevent XSS attacks.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = sanitizeInput('<div>hello world</div>');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * &lt;div&gt;hello world&lt;/div&gt;
+ * ```
  *
  * @param input - The input string to sanitize
  * @returns The sanitized input string
@@ -921,6 +1321,19 @@ export declare function sanitizeInput(input: string): string;
 /**
  * Reverses the sanitization done by the `sanitizeInput` function.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = unsanitize('&lt;div&gt;hello world&lt;/div&gt;');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * <div>hello world</div>
+ * ```
+ *
  * @param input - The input string to unsanitize
  * @returns The unsanitized input string
  * @category Util
@@ -929,6 +1342,19 @@ export declare function unsanitize(input: string): string;
 /**
  * 截取字符串，中文算 2 个字节
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = truncateZHString('hello world', 5);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello
+ * ```
+ *
  * @param {string} str 要截取的字符串
  * @param {number} len
  * @param {boolean} hasDot
@@ -947,16 +1373,24 @@ export declare function cutCHSString(str: string, len: number, hasDot?: boolean)
  *
  * ZH: 页面加载完成
  *
- * ```
+ * Usage:
+ *
+ * ```javascript
  * windowLoaded(30) // second
  *   .then(res => {
- *     console.log(`Load Success: ${res}`); // Load Success: load
+ *     console.log(`Load Success: ${res}`);
  *   })
  *   .catch(err => {
  *     console.log(`Load Timeout or Fail: ${err.message}`);
  *   });
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * Load Success: load
+ * ```
+ *
  * @param {number} timeout 超时时间 / 单位：秒
  * @returns {Promise<string>} document is loaded? 'complete' 'load' / 'timeout'
  * @category Load Resource
@@ -969,7 +1403,7 @@ export declare function windowLoaded(timeout?: number): Promise<string | Error>;
  *
  * Example 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
  *
- * ```
+ * ```javascript
  * addStyle(
  *   `
  *     body {
@@ -989,7 +1423,7 @@ export declare function windowLoaded(timeout?: number): Promise<string | Error>;
  *
  * Example 2: Add the `<style>` without `id`, and repeated invoking will add a new one.
  *
- * ```
+ * ```javascript
  * addStyle(
  *   `
  *     body {
@@ -1016,7 +1450,7 @@ export declare function addStyle(style: string, options?: {
  *
  * Usage:
  *
- * ```
+ * ```javascript
  * const myConsole = genCustomConsole('MazeyLog:');
  * myConsole.log('I am string.');
  * myConsole.info('I am boolean.', true);
@@ -1026,7 +1460,7 @@ export declare function addStyle(style: string, options?: {
  *
  * Output:
  *
- * ```
+ * ```text
  * MazeyLog: I am string.
  * MazeyLog: I am boolean. true
  * MazeyLog: I am number. 123 456
@@ -1060,6 +1494,19 @@ export declare function zAxiosIsValidRes(res: ZResResponse | undefined, options?
 /**
  * Verify the validity of a non-empty array.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = isNonEmptyArray([1, 2, 3]);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
  * @category Util
  */
 export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
@@ -1068,7 +1515,7 @@ export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
  *
  * Usage:
  *
- * ```
+ * ```javascript
  * const validData = {
  *   a: {
  *     b: {
@@ -1088,7 +1535,7 @@ export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
  *
  * Output:
  *
- * ```
+ * ```text
  * isValidDataResA: false
  * isValidDataResB: true
  * isValidDataResC: false
@@ -1102,7 +1549,20 @@ export declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
  */
 export declare function isValidData(data: UnknownObject, attributes: string[], validValue: SimpleType): boolean;
 /**
- * 语义化文件大小, 把字节转换成正常文件大小.
+ * 语义化文件大小，把字节转换成正常文件大小。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = getFileSize(1024);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1 KB
+ * ```
  *
  * @category Util
  */
@@ -1110,6 +1570,20 @@ export declare function getFileSize(size: number): string;
 /**
  * Detect webp support.
  *
+ * Usage:
+ *
+ * ```javascript
+ * isSupportWebp().then(res => {
+ *  console.log('isSupportWebp:', res);
+ * });
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * isSupportWebp: true
+ * ```
+ *
  * Reference: [Detect WEBP Support with JavaScript](https://davidwalsh.name/detect-webp)
  *
  * @category Browser Information
@@ -1118,6 +1592,19 @@ export declare function isSupportWebp(): Promise<boolean>;
 /**
  * Generate a Hash Code from a string.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = genHashCode('hello world');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1794106052
+ * ```
+ *
  * Reference: [Generate a Hash from string in Javascript](https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery)
  *
  * @category Util
@@ -1128,16 +1615,20 @@ export declare function genHashCode(str: string): number;
  *
  * 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'));
+ * ```javascript
+ * const ret1 = formatDate();
+ * const ret2 = formatDate('Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)', 'yyyy-MM-dd hh:mm:ss');
+ * const ret3 = formatDate(1641881235000, 'yyyy-MM-dd hh:mm:ss');
+ * const ret4 = formatDate(new Date(2014, 1, 11), 'MM/dd/yyyy');
+ * console.log('Default formatDate value:', ret1);
+ * console.log('String formatDate value:', ret2);
+ * console.log('Number formatDate value:', ret3);
+ * console.log('Date formatDate value:', ret4);
  * ```
  *
  * Output:
  *
- * ```
+ * ```text
  * Default formatDate value: 2023-01-11
  * String formatDate value: 2022-01-11 14:12:26
  * Number formatDate value: 2022-01-11 14:07:15
@@ -1153,6 +1644,12 @@ export declare function formatDate(dateIns?: Date | number | string, format?: st
 /**
  * Get event container.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = getEventContainer();
+ * ```
+ *
  * @category Event
  * @hidden
  */
@@ -1160,6 +1657,14 @@ export declare function getDefineListeners(): DefineListeners;
 /**
  * Add event.
  *
+ * Usage:
+ *
+ * ```javascript
+ * addEvent('test', (e) => {
+ *  console.log('test event:', e);
+ * });
+ * ```
+ *
  * @param type
  * @param fn
  * @category Event
@@ -1168,6 +1673,12 @@ export declare function addEvent(type: string, fn: UnknownFn): void;
 /**
  * Invoke event.
  *
+ * Usage:
+ *
+ * ```javascript
+ * invokeEvent('test');
+ * ```
+ *
  * @param type
  * @category Event
  */
@@ -1175,6 +1686,12 @@ export declare function invokeEvent(type: string): void;
 /**
  * Remove event.
  *
+ * Usage:
+ *
+ * ```javascript
+ * removeEvent('test');
+ * ```
+ *
  * @param type
  * @param fn
  * @category Event
@@ -1183,13 +1700,21 @@ 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
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = isValidUrl('https://www.example.com');
+ * const ret2 = isValidUrl('http://example.com/path/exx/ss');
+ * const ret3 = isValidUrl('https://www.example.com/?q=hello&age=24#world');
+ * const ret4 = isValidUrl('http://www.example.com/#world?id=9');
+ * const ret5 = isValidUrl('ftp://example.com');
+ * console.log(ret1, ret2, ret3, ret4, ret5);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true true true true true
  * ```
  *
  * @remarks
@@ -1204,13 +1729,21 @@ 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
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = isValidHttpUrl('https://www.example.com');
+ * const ret2 = isValidHttpUrl('http://example.com/path/exx/ss');
+ * const ret3 = isValidHttpUrl('https://www.example.com/?q=hello&age=24#world');
+ * const ret4 = isValidHttpUrl('http://www.example.com/#world?id=9');
+ * const ret5 = isValidHttpUrl('ftp://example.com');
+ * console.log(ret1, ret2, ret3, ret4, ret5);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true true true true false
  * ```
  *
  * @param url
@@ -1221,12 +1754,20 @@ 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
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = isMobile('13800138000');
+ * const ret2 = isMobile('1380013800');
+ * const ret3 = isMobile('138001380000');
+ * const ret4 = isMobile('1380013800a');
+ * console.log(ret1, ret2, ret3, ret4);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false false
  * ```
  *
  * @param mobile
@@ -1237,9 +1778,17 @@ 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
+ * Usage:
+ *
+ * ```javascript
+ * const ret = isValidEmail('mazeyqian@gmail.com');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
  * ```
  *
  * @param email
@@ -1250,13 +1799,21 @@ 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
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = convert10To26(1);
+ * const ret2 = convert10To26(26);
+ * const ret3 = convert10To26(27);
+ * const ret4 = convert10To26(52);
+ * const ret5 = convert10To26(53);
+ * console.log(ret1, ret2, ret3, ret4, ret5);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * a z aa az ba
  * ```
  *
  * @param {number} num
@@ -1269,13 +1826,21 @@ export declare function convert10To26(num: number): string;
  *
  * 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')); // ''
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = getUrlFileType('https://example.com/a/b/c.png');
+ * const ret2 = getUrlFileType('https://example.com/a/b/c.jpg');
+ * const ret3 = getUrlFileType('https://example.com/a/b/c.jpeg');
+ * const ret4 = getUrlFileType('/a/b/c.jpeg');
+ * const ret5 = getUrlFileType('https://example.com/a/b/c.v/a');
+ * console.log(ret1, ret2, ret3, ret4, ret5);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * png jpg jpeg jpeg ''
  * ```
  *
  * @param url
@@ -1288,8 +1853,9 @@ export declare function getUrlFileType(url: string): boolean | string;
  * 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
- * ```
+ * Usage:
+ *
+ * ```javascript
  * // 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');
@@ -1307,10 +1873,20 @@ 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;}'
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = genStyleString('.a', [ 'color:red' ]);
+ * const ret2 = genStyleString('#b', [ 'color:red', 'font-size:12px' ]);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * .a{color:red;}
+ * #b{color:red;font-size:12px;}
  * ```
  *
  * @param {string} selector
@@ -1326,8 +1902,9 @@ export declare function genStyleString(selector: string, styleArray: Array<strin
  *
  * Note that this method will not add the image to the DOM.
  *
- * @example
- * ```js
+ * Usage:
+ *
+ * ```javascript
  * loadImage('https://example.com/example.png')
  *   .then((img) => {
  *     console.log(img);
@@ -1351,6 +1928,24 @@ export declare function getCurrentVersion(): string;
 /**
  * Repeatedly fires a callback function with a certain interval until a specified condition is met.
  *
+ * Usage:
+ *
+ * ```javascript
+ * repeatUntilConditionMet(
+ *   () => {
+ *     console.log('repeatUntilConditionMet');
+ *     return true;
+ *   }, {
+ *     interval: 1000,
+ *     times: 10,
+ *     context: null,
+ *     args: [],
+ *   }, (result) => {
+ *     return result === true;
+ *   }
+ * );
+ * ```
+ *
  * @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.
@@ -1364,17 +1959,24 @@ export declare function repeatUntilConditionMet<T extends (...args: UnknownFnPar
 /**
  * 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')
+ * Usage:
+ *
+ * ```javascript
+ * loadScriptIfUndefined('xyz', 'https://example.com/lib/jquery.min.js')
  *   .then(() => {
- *     console.log('jQuery is loaded.');
+ *     console.log('xyz is loaded.');
  *   })
  *   .catch(err => {
- *     console.log('Failed to load jQuery.', err);
+ *     console.log('Failed to load xyz.', err);
  *   });
  * ```
  *
+ * Output:
+ *
+ * ```text
+ * xyz is loaded.
+ * ```
+ *
  * @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.
@@ -1384,6 +1986,19 @@ export declare function loadScriptIfUndefined(windowAttribute: string, url: stri
 /**
  * Retrieve a query parameter from a script URL in the browser.
  *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = getScriptQueryParam('test', 'https://example.com/example.js');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello
+ * ```
+ *
  * @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.
@@ -1394,6 +2009,20 @@ export declare function getScriptQueryParam(param: string, matchString?: string)
 /**
  * Wait for a specified amount of time.
  *
+ * Usage:
+ *
+ * ```javascript
+ * waitTime(1000).then((time) => {
+ *  console.log('waitTime:', time);
+ * });
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * waitTime: 1000
+ * ```
+ *
  * @param time The amount of time to wait, in milliseconds.
  * @returns A Promise that resolves after the specified time has elapsed.
  * @category Util