mazey 4.11.0 → 4.11.2

package/lib/index.d.ts

@@ -0,0 +1,2979 @@
+/**
+ * EN: Computes the longest common substring of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子串。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { longestComSubstring } from "mazey";
+ *
+ * const ret = longestComSubstring("fish", "finish");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3
+ * ```
+ *
+ * @param {string} aStr String
+ * @param {string} bStr String
+ * @returns {number} Length
+ * @category Calculate and Formula
+ */
+declare function longestComSubstring(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubstring`.
+ *
+ * @hidden
+ */
+declare function calLongestCommonSubstring(aStr: string, bStr: string): number;
+/**
+ * EN: Computes the longest common subsequence of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子序列。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { longestComSubsequence } from "mazey";
+ *
+ * const ret = longestComSubsequence("fish", "finish");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 4
+ * ```
+ *
+ * @param {string} aStr 字符串
+ * @param {string} bStr 字符串
+ * @returns {number} 长度
+ * @category Calculate and Formula
+ */
+declare function longestComSubsequence(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubsequence`.
+ *
+ * @hidden
+ */
+declare function calLongestCommonSubsequence(aStr: string, bStr: string): number;
+/**
+ * EN: Hit probability (1% ~ 100%).
+ *
+ * ZH: 百分位概率。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isHit } from "mazey";
+ *
+ * const ret = isHit(0.5); // 0.01 ~ 1 true/false
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * Example: Test the precision.
+ *
+ * ```javascript
+ * let trueCount = 0;
+ * let falseCount = 0;
+ * new Array(1000000).fill(0).forEach(() => {
+ *   if (isHit(0.5)) {
+ *     trueCount++;
+ *   } else {
+ *     falseCount++;
+ *   }
+ * });
+ * console.log(trueCount, falseCount);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 499994 500006
+ * ```
+ *
+ * @param {number} rate 0.1 ~ 1 => 1% ~ 100%
+ * @returns {boolean} true 命中
+ * @category Calculate and Formula
+ */
+declare function isHit(rate: number): boolean;
+/**
+ * Alias of `isHit`.
+ *
+ * @hidden
+ */
+declare function inRate(rate: number): boolean;
+
+/**
+ * @author Cheng
+ */
+
+interface BrowserInfo {
+  engine: string; // webkit gecko presto trident
+  engineVs: string;
+  platform: string; // desktop mobile
+  supporter: string; // chrome safari firefox opera iexplore edge
+  supporterVs: string;
+  system: string; // windows macos linux android ios
+  systemVs: string;
+  shell: string; // wechat qq uc 360 2345 sougou liebao maxthon
+  shellVs: string;
+  appleType: string;
+  colorScheme: string;
+}
+
+interface DefineListeners {
+  [key: string]: any;
+}
+
+type SingleValueUrlParams = {
+  [key: string]: string;
+};
+
+type ThrottleFunc<T extends (...args: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | null;
+
+type DebounceFunc<T extends (...args: any[]) => any> = (...args: Parameters<T>) => ReturnType<T>;
+
+interface IsNumberOptions {
+  isNaNAsNumber?: boolean;
+  isInfinityAsNumber?: boolean;
+  isUnFiniteAsNumber?: boolean;
+}
+
+interface ZResResponse {
+  status: number;
+  data: {
+    code: number;
+  };
+}
+
+interface ZResIsValidResOptions {
+  validStatusRange?: [number, number];
+  validCode?: number[];
+}
+
+interface RepeatUntilOptions {
+  interval?: number;
+  times?: number;
+  context?: any;
+  args?: Array<any>;
+}
+
+type LoadScriptReturns = Promise<boolean | string | Error | void>;
+
+type SimpleType = string | number | boolean | null | undefined;
+
+type MazeyObject = any;
+type MazeyFnParams = any[];
+type MazeyFnReturn = any;
+type MazeyFunction = (...args: any[]) => any;
+type MazeyFn = (...args: MazeyFnParams) => MazeyFnReturn;
+
+interface WebPerformance {
+  [key: string]: string | number;
+}
+
+type MazeyElement = HTMLElement | null;
+
+type MazeyDate = Date | string | number;
+
+type URLChangeTrigger = "load" | "popstate" | "hashchange" | "pushState" | "replaceState";
+
+interface URLChangeInfo {
+  url: string;
+  oldUrl: string;
+  trigger: URLChangeTrigger;
+}
+
+interface OnURLChangeOptions {
+  fireOnInit?: boolean;
+}
+
+/**
+ * Copy/Clone Object deeply.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { deepCopy } from "mazey";
+ *
+ * const ret1 = deepCopy(["a", "b", "c"]);
+ * const ret2 = deepCopy("abc");
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * ["a", "b", "c"]
+ * abc
+ * ```
+ *
+ * @param {object} obj The value to clone.
+ * @returns {object} Returns the deep cloned value.
+ * @category Util
+ */
+declare function deepCopy<T>(obj: T): T;
+/**
+ * Alias of `deepCopy`.
+ *
+ * @hidden
+ */
+declare function deepCopyObject<T>(obj: T): T;
+/**
+ * Convert CamelCase to KebabCase.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertCamelToKebab } from "mazey";
+ *
+ * const ret1 = convertCamelToKebab("ABC");
+ * const ret2 = convertCamelToKebab("aBC");
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * a-b-c
+ * a-b-c
+ * ```
+ *
+ * @param {string} camelCase "aBC" or "ABC"
+ * @returns {string} "a-b-c"
+ * @category Util
+ */
+declare function convertCamelToKebab(camelCase: string): string;
+/**
+ * Convert KebabCase to CamelCase.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertKebabToCamel } from "mazey";
+ *
+ * const ret1 = convertKebabToCamel("a-b-c");
+ * const ret2 = convertKebabToCamel("a-bb-cc");
+ * console.log(ret1, ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * aBC aBbCc
+ * ```
+ *
+ * @param {string} kebabCase "a-bb-cc"
+ * @returns {string} "aBbCc"
+ * @category Util
+ */
+declare function convertKebabToCamel(kebabCase: string): string;
+/**
+ * Alias of `convertCamelToKebab`.
+ *
+ * @hidden
+ */
+declare function camelCaseToKebabCase(camelCase: string): string;
+/**
+ * Convert CamelCase to Underscore.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertCamelToUnder } from "mazey";
+ *
+ * const ret1 = convertCamelToUnder("ABC");
+ * const ret2 = convertCamelToUnder("aBC");
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * a_b_c
+ * a_b_c
+ * ```
+ *
+ * @param {string} camelCase "aBC" or "ABC"
+ * @returns {string} "a_b_c"
+ * @category Util
+ */
+declare function convertCamelToUnder(camelCase: string): string;
+/**
+ * Convert Underscore to CamelCase.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertUnderToCamel } from "mazey";
+ *
+ * const ret1 = convertUnderToCamel("a_b_c");
+ * const ret2 = convertUnderToCamel("a_bb_cc");
+ * console.log(ret1, ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * aBC aBbCc
+ * ```
+ *
+ * @param {string} underCase "a_bb_cc"
+ * @returns {string} "aBbCc"
+ * @category Util
+ */
+declare function convertUnderToCamel(underCase: string): string;
+/**
+ * Alias of `convertCamelToUnder`.
+ *
+ * @hidden
+ */
+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.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { mTrim } from "mazey";
+ *
+ * const ret1 = mTrim(" 1 2 3 ");
+ * const ret2 = mTrim("abc ");
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1 2 3
+ * abc
+ * ```
+ *
+ * @param {string} str The string to trim.
+ * @returns {string} Trimmed string.
+ * @category Util
+ * @hidden
+ */
+declare function mTrim(str: string): string;
+/**
+ * Check whether it is a valid JSON string.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isJSONString } from "mazey";
+ *
+ * const ret1 = isJSONString(`['a', 'b', 'c']`);
+ * const ret2 = isJSONString(`["a", "b", "c"]`);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * false
+ * true
+ * ```
+ *
+ * @param {string} str The string to check.
+ * @returns {boolean} Return the result of checking.
+ * @category Util
+ */
+declare function isJSONString(str: string): boolean;
+/**
+ * Alias of `isJSONString`.
+ *
+ * @hidden
+ */
+declare function isJsonString(str: string): boolean;
+/**
+ * Generate a random string of number, `genRndNumString(7)` => "7658495".
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { genRndNumString } from "mazey";
+ *
+ * const ret1 = genRndNumString(4);
+ * const ret2 = genRndNumString(7);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 9730
+ * 2262490
+ * ```
+ *
+ * @param {number} n Length
+ * @returns {string} Return the random string.
+ * @category Util
+ */
+declare function genRndNumString(n?: number): string;
+/**
+ * Alias of `genRndNumString`.
+ *
+ * @hidden
+ */
+declare function generateRndNum(n?: number): string;
+/**
+ * EN: Generate a unique identifier number based on time: `genUniqueNumString()` => `1538324722364123`
+ *
+ * ZH: 根据时间生成唯一标志的数字：`genUniqueNumString()` => `1538324722364123`。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { genUniqueNumString } from "mazey";
+ *
+ * const ret1 = genUniqueNumString();
+ * const ret2 = genUniqueNumString(3);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1538324722364123
+ * 1538324722364123
+ * ```
+ *
+ * @param {number} n 随机数的长度
+ * @category Util
+ */
+declare function genUniqueNumString(n?: number): string;
+/**
+ * Alias of `genUniqueNumString`.
+ *
+ * @hidden
+ */
+declare function generateUniqueNum(n?: number): string;
+/**
+ * EN: Get timestamp.
+ *
+ * ZH: 获取时间戳。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { mNow } from "mazey";
+ *
+ * const ret = mNow();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1585325367122
+ * ```
+ *
+ * @category Util
+ */
+declare function mNow(): number;
+/**
+ * EN: Floating point number to percentage 0.2 => 20%
+ *
+ * ZH: 浮点数转为百分比 0.2 => 20%。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { floatToPercent } from "mazey";
+ *
+ * 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
+ */
+declare function floatToPercent(num: number, fixSize?: number): string;
+/**
+ * EN: Keep the specified number of decimal places for floating-point numbers.
+ *
+ * ZH: 浮点数保留指定位。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { floatFixed } from "mazey";
+ *
+ * const ret1 = floatFixed(0.2);
+ * const ret2 = floatFixed(0.2, 2);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 0
+ * 0.20
+ * ```
+ *
+ * @category Util
+ */
+declare function floatFixed(num: string, size?: number): string;
+/**
+ * EN: Throttle, used to limit the frequency of function execution over time.
+ *
+ * ZH: 节流，用于限制函数在一段时间内的执行频率。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { throttle } from "mazey";
+ *
+ * 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
+ */
+declare function throttle<T extends (...args: MazeyFnParams) => MazeyFnReturn>(func: T, wait: number, options?: {
+    leading?: boolean;
+    trailing?: boolean;
+}): ThrottleFunc<T>;
+/**
+ * EN: Debounce, used to delay the execution of a function until a specified time has passed since the last invocation.
+ *
+ * ZH: 防抖，用于在最后一次调用后的指定时间内延迟函数的执行。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { debounce } from "mazey";
+ *
+ * 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
+ */
+declare function debounce<T extends (...args: MazeyFnParams) => MazeyFnReturn>(func: T, wait: number, immediate?: boolean): DebounceFunc<T>;
+/**
+ * EN: Get interval time.
+ *
+ * ZH: 获取间隔时间。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getFriendlyInterval } from "mazey";
+ *
+ * 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
+ * @param {number/Date} end 结束时间戳 1585325367122
+ * @param {string} options.type 返回类型 d: 2(天) text: 2 天 4 时...
+ * @returns {string/number} 取决于 type
+ * @category Util
+ */
+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: 判断是否有效数字。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isNumber } from "mazey";
+ *
+ * const ret1 = isNumber(123);
+ * const ret2 = isNumber("123");
+ * // Default: NaN, Infinity is not Number
+ * 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 被判断的值
+ * @param {boolean} options.isNaNAsNumber 是否 NaN 算数字（默认不算）
+ * @param {boolean} options.isInfinityAsNumber 是否 无限 算数字（默认不算）
+ * @returns {boolean} true 是数字
+ * @category Util
+ */
+declare function isNumber(num: unknown, options?: IsNumberOptions): boolean;
+/**
+ * EN: Invoke effective function.
+ *
+ * ZH: 执行有效函数。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { invokeFn } from "mazey";
+ *
+ * const ret = invokeFn(() => {
+ *  console.log("invokeFn");
+ * });
+ * ```
+ *
+ * @param {function} fn 等待被执行的未知是否有效的函数
+ * @category Util
+ */
+declare function invokeFn(fn: MazeyFunction, ...params: Parameters<MazeyFunction>): ReturnType<MazeyFunction> | null;
+/**
+ * Alias of `invokeFn`.
+ *
+ * @hidden
+ */
+declare function doFn(fn: MazeyFunction, ...params: Parameters<MazeyFunction>): ReturnType<MazeyFunction> | null;
+/**
+ * Verify the validity of a non-empty array.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isNonEmptyArray } from "mazey";
+ *
+ * const ret = isNonEmptyArray([1, 2, 3]);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * @category Util
+ */
+declare function isNonEmptyArray<T>(arr: Array<T>): boolean;
+/**
+ * Verify the validity of a pure object.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isPureObject } from "mazey";
+ *
+ * const ret1 = isPureObject({ a: 1 });
+ * const ret2 = isPureObject("abc");
+ * const ret3 = isPureObject(null);
+ * const ret4 = isPureObject([]);
+ *
+ * console.log(ret1, ret2, ret3, ret4);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false false
+ * ```
+ *
+ * @param {MazeyObject} obj The object to verify.
+ * @returns {boolean} Return TRUE if the object is a pure object.
+ * @category Util
+ */
+declare function isPureObject(obj: MazeyObject): boolean;
+/**
+ * Verify the validity of a function.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isFunction } from "mazey";
+ *
+ * const ret1 = isFunction(() => {});
+ * const ret2 = isFunction("abc");
+ * const ret3 = isFunction(null);
+ * console.log(ret1, ret2, ret3);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false
+ * ```
+ *
+ * @param {MazeyObject} fn The function to verify.
+ * @returns {boolean} Return TRUE if the object is a function.
+ * @category Util
+ */
+declare function isFunction(fn: MazeyObject): boolean;
+/**
+ * Verify the validity of a string.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isString } from "mazey";
+ *
+ * const ret1 = isString("abc");
+ * const ret2 = isString({ a: 1 });
+ * const ret3 = isString(null);
+ * console.log(ret1, ret2, ret3);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false
+ * ```
+ *
+ * @param {MazeyObject} str The string to verify.
+ * @returns {boolean} Return TRUE if the object is a string.
+ * @category Util
+ */
+declare function isString(str: MazeyObject): boolean;
+/**
+ * Verify the validity of a boolean.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isBool } from "mazey";
+ *
+ * const ret1 = isBool(true);
+ * const ret2 = isBool({ a: 1 });
+ * const ret3 = isBool("abc");
+ * const ret4 = isBool(null);
+ * console.log(ret1, ret2, ret3, ret4);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false false
+ * ```
+ *
+ * @param {MazeyObject} bool The boolean to verify.
+ * @returns {boolean} Return TRUE if the object is a boolean.
+ * @category Util
+ */
+declare function isBool(bool: MazeyObject): boolean;
+/**
+ * Alias of `isBool`.
+ */
+declare function isBoolean(bool: MazeyObject): boolean;
+/**
+ * Verify the validity of a value.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isUdfOrNul } from "mazey";
+ *
+ * const ret1 = isUdfOrNul(undefined);
+ * const ret2 = isUdfOrNul(null);
+ * const ret3 = isUdfOrNul("abc");
+ * console.log(ret1, ret2, ret3);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true true false
+ * ```
+ *
+ * @param {MazeyObject} val The value to verify.
+ * @returns {boolean} Return TRUE if the object is undefined or null.
+ * @category Util
+ */
+declare function isUdfOrNul(val: MazeyObject): boolean;
+/**
+ * Verify the validity of an array.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isArray } from "mazey";
+ *
+ * const ret1 = isArray([1, 2, 3]);
+ * const ret2 = isArray({ a: 1 });
+ * const ret3 = isArray("abc");
+ * const ret4 = isArray(null);
+ * console.log(ret1, ret2, ret3, ret4);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false false
+ * ```
+ *
+ * @param {MazeyObject} obj The object to verify.
+ * @returns {boolean} Return TRUE if the object is an array.
+ * @category Util
+ */
+declare function isArray(obj: MazeyObject): boolean;
+/**
+ * Verify the validity of a non-empty object.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isNonEmptyObject } from "mazey";
+ *
+ * const ret1 = isNonEmptyObject({ a: 1 });
+ * const ret2 = isNonEmptyObject({});
+ * const ret3 = isNonEmptyObject("abc");
+ * const ret4 = isNonEmptyObject(null);
+ * console.log(ret1, ret2, ret3, ret4);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true false false false
+ * ```
+ *
+ * @param obj
+ * @returns
+ */
+declare function isNonEmptyObject(obj: MazeyObject): boolean;
+/**
+ * Convert newline characters `\n` into HTML line breaks `<br />`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertToHtmlBreaks } from "mazey";
+ *
+ * const ret1 = convertToHtmlBreaks("a\nb\nc");
+ * const ret2 = convertToHtmlBreaks("a\n\nbc");
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * a<br />b<br />c
+ * a<br /><br />bc
+ * ```
+ *
+ * @param {string} str The string to make a new line.
+ * @returns {string} A newline with `br`.
+ * @category Util
+ */
+declare function convertToHtmlBreaks(str: string): string;
+/**
+ * Alias of `convertToHtmlBreaks`.
+ *
+ * @hidden
+ */
+declare function newLine(str: string): string;
+/**
+ * Remove HTML tags from a string, and optionally newline characters.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { removeHTML } from "mazey";
+ *
+ * const ret = removeHTML("<div>hello world</div>");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello world
+ * ```
+ *
+ * @param {string} str 带 HTML 标签的字符串
+ * @returns {string} 字符串
+ * @category Util
+ */
+declare function removeHTML(str: string, options?: {
+    removeNewLine?: boolean;
+}): string;
+/**
+ * Alias of `removeHTML`.
+ *
+ * @hidden
+ */
+declare function removeHtml(str: string, options?: {
+    removeNewLine?: boolean;
+}): string;
+/**
+ * Alias of `removeHTML`.
+ *
+ * @hidden
+ */
+declare function clearHTML(str: string, options?: {
+    removeNewLine?: boolean;
+}): string;
+/**
+ * Alias of `removeHTML`.
+ *
+ * @hidden
+ */
+declare function clearHtml(str: string, options?: {
+    removeNewLine?: boolean;
+}): string;
+/**
+ * Sanitizes user input to prevent XSS attacks.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { sanitizeInput } from "mazey";
+ *
+ * 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
+ * @category Util
+ */
+declare function sanitizeInput(input: string): string;
+/**
+ * Reverses the sanitization done by the `sanitizeInput` function.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { unsanitizeInput } from "mazey";
+ *
+ * const ret = unsanitizeInput("&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
+ */
+declare function unsanitizeInput(input: string): string;
+/**
+ * Alias of `unsanitizeInput`.
+ *
+ * @hidden
+ */
+declare function unsanitize(str: string): string;
+/**
+ * EN: Truncate string, Chinese characters count as 2 bytes.
+ *
+ * ZH: 截取字符串，中文算 2 个字节。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { cutZHString } from "mazey";
+ *
+ * const ret = cutZHString("hello world", 5);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello
+ * ```
+ *
+ * @param {string} str 要截取的字符串
+ * @param {number} len
+ * @param {boolean} options.hasDot
+ * @param {string} options.dotText
+ * @returns {string} 返回截取后的字符串
+ * @category Util
+ */
+declare function cutZHString(str: string, len: number, options?: {
+    hasDot?: boolean;
+    dotText?: string;
+}): string;
+/**
+ * Alias of `cutZHString`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { truncateZHString } from "mazey";
+ *
+ * const ret = truncateZHString("hello world", 5);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * hello
+ *
+ * @param {string} str 要截取的字符串
+ * @param {number} len
+ * @param {boolean} hasDot
+ * @returns {string} 返回截取后的字符串
+ * @hidden
+ */
+declare function truncateZHString(str: string, len: number, hasDot?: boolean): string;
+/**
+ * Alias of `truncateZHString`.
+ *
+ * @hidden
+ */
+declare function cutCHSString(str: string, len: number, hasDot?: boolean): string;
+/**
+ * Verify the validity of axios response.
+ *
+ * Reference: [Handling Errors](https://axios-http.com/docs/handling_errors)
+ *
+ * @category Util
+ * @hidden
+ */
+declare function zAxiosIsValidRes(res: ZResResponse | undefined, options?: ZResIsValidResOptions): boolean;
+/**
+ * Determine the validity of the data.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isValidData } from "mazey";
+ *
+ * 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:
+ *
+ * ```text
+ * 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
+ */
+declare function isValidData(data: MazeyObject, attributes: string[], validValue: SimpleType): boolean;
+/**
+ * EN: Semantic file size, convert bytes into a readable file size.
+ *
+ * ZH: 语义化文件大小，把字节转换成正常文件大小。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getFileSize } from "mazey";
+ *
+ * const ret = getFileSize(1024);
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 1 KB
+ * ```
+ *
+ * @category Util
+ */
+declare function getFileSize(size: number): string;
+/**
+ * Generate a Hash Code from a string.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { genHashCode } from "mazey";
+ *
+ * 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
+ */
+declare function genHashCode(str: string): number;
+/**
+ * Return the formatted date string in the given format.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { formatDate } from "mazey";
+ *
+ * const ret1 = formatDate();
+ * const ret2 = formatDate("Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)", "yyyy-MM-dd hh:mm:ss a");
+ * const ret3 = formatDate(1641881235000, "yyyy-MM-dd hh:mm:ss a");
+ * 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 02:12:26 PM
+ * Number formatDate value: 2022-01-11 02:07:15 PM
+ * Date formatDate value: 02/11/2014
+ * ```
+ *
+ * @param {MazeyDate} dateIns Original Date
+ * @param {string} format Format String
+ * @returns {string} Return the formatted date string.
+ * @category Util
+ */
+declare function formatDate(dateIns?: MazeyDate, format?: string): string;
+/**
+ * Check if the given string is a mobile phone number.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isMobile } from "mazey";
+ *
+ * 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
+ * @returns {boolean} Return true if the given string is a mobile phone number.
+ * @category Util
+ */
+declare function isValidPhoneNumber(mobile: string): boolean;
+/**
+ * Check if the given string is a valid email.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isValidEmail } from "mazey";
+ *
+ * const ret = isValidEmail("mazeyqian@gmail.com");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * @param email
+ * @returns {boolean} Return true if the given string is a valid email.
+ * @category Util
+ */
+declare function isValidEmail(email: string): boolean;
+/**
+ * Convert a given 10-hex number to a lowercase 26-hex string.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convert10To26 } from "mazey";
+ *
+ * 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
+ * @returns {string} Return a lowercase 26-hex string.
+ * @category Util
+ */
+declare function convert10To26(num: number): string;
+/**
+ * Get the current version.
+ *
+ * @hidden
+ */
+declare function getCurrentVersion(): string;
+/**
+ * Repeatedly fires a callback function with a certain interval until a specified condition is met.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { repeatUntilConditionMet } from "mazey";
+ *
+ * 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.
+ * @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
+ */
+declare function repeatUntilConditionMet<T extends (...args: MazeyFnParams) => MazeyFnReturn>(callback: T, options?: RepeatUntilOptions, condition?: (result: ReturnType<T>) => boolean): void;
+/**
+ * Wait for a specified amount of time.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { waitTime } from "mazey";
+ *
+ * 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
+ */
+declare function waitTime(time: number): Promise<number>;
+/**
+ * Alias of `waitTime`.
+ *
+ * @hidden
+ */
+declare function sleep(time: number): Promise<number>;
+/**
+ * Determine if it is a browser environment.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isBrowser } from "mazey";
+ *
+ * const ret = isBrowser();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * @returns {boolean} true Yes
+ * @category Browser Information
+ */
+declare function isBrowser(): boolean;
+
+/**
+ * Get the query param's value of the current Web URL(`location.search`).
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getQueryParam } from "mazey";
+ *
+ * // http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
+ * // ?t1=1&t2=2&t3=3&t4=4
+ * const p1 = getQueryParam("t3");
+ * const p2 = getQueryParam("t4");
+ * console.log(p1, p2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3 4
+ * ```
+ *
+ * @param {string} param Query param.
+ * @returns {string} value
+ * @category URL
+ */
+declare function getQueryParam(param: string): string;
+/**
+ * Get the all query params of the current Web URL(`location.search`).
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getAllQueryParams } from "mazey";
+ *
+ * // http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
+ * // ?t1=1&t2=2&t3=3&t4=4
+ * const ret = getAllQueryParams();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * { t1: "1", t2: "2", t3: "3", t4: "4" }
+ * ```
+ *
+ * @param {string} url Optional, The URL string.
+ * @returns {object} The query params object.
+ * @category URL
+ */
+declare function getAllQueryParams(url?: string): SingleValueUrlParams;
+/**
+ * Returns the value of the specified query parameter in the input URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getUrlParam } from "mazey";
+ *
+ * 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);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3 4
+ * ```
+ *
+ * @param {string} url The URL string.
+ * @param {string} param The query parameter to retrieve the value for.
+ * @param {object} options The options object.
+ * @param {boolean} options.returnArray Whether to return an array of values for the specified query parameter. Default is false.
+ * @returns {string|string[]} The value of the specified query parameter, or an empty string if the parameter is not found.
+ * @category URL
+ */
+declare function getUrlParam(url: string, param: string, options?: {
+    returnArray?: boolean;
+}): string | string[] | null;
+/**
+ * Update the query param's value of the input URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { updateQueryParam } from "mazey";
+ *
+ * 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
+ * ```
+ *
+ * @param {string} url URL string.
+ * @param {string} param Query param.
+ * @param {string} value Param's value.
+ * @returns {string} URL.
+ * @category URL
+ */
+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:
+ *
+ * ```javascript
+ * import { getHashQueryParam } from "mazey";
+ *
+ * // http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
+ * // #2333?t1=1&t2=2&t3=3&t4=4
+ * const p1 = getHashQueryParam("t3");
+ * const p2 = getHashQueryParam("t4");
+ * console.log(p1, p2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3 4
+ * ```
+ *
+ * @param {string} param Query param.
+ * @returns {string} value
+ * @category URL
+ */
+declare function getHashQueryParam(param: string): string;
+/**
+ * Get the domain of URL, and other params.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getDomain } from "mazey";
+ *
+ * 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
+ * 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
+ */
+declare function getDomain(url: string, rules?: string[]): string;
+/**
+ * Checks if the given string is a valid URL, including **scheme URLs**.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isValidUrl } from "mazey";
+ *
+ * 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
+ * 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
+ */
+declare function isValidUrl(url: string): boolean;
+/**
+ * Check if the given string is a valid HTTP/HTTPS URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isValidHttpUrl } from "mazey";
+ *
+ * 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("//example.com/a/b/c?q=1", { strict: false });
+ * const ret6 = isValidHttpUrl("ftp://example.com");
+ * console.log(ret1, ret2, ret3, ret4, ret5, ret6);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true true true true true false
+ * ```
+ *
+ * @param url
+ * @param options.strict - If `true`, the function only matches standard HTTP/HTTPS URLs. Default is `true`. If `false`, the function also matches protocol-relative URLs, such as `//example.com`.
+ * @returns {boolean} Return true if the given string is a valid HTTP/HTTPS URL.
+ * @category URL
+ */
+declare function isValidHttpUrl(url: string, options?: {
+    strict: boolean;
+}): boolean;
+/**
+ * EN: Get the file type of the url.
+ *
+ * ZH: 获取文件后缀名。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getUrlFileType } from "mazey";
+ *
+ * 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
+ * @returns
+ * @category URL
+ */
+declare function getUrlFileType(url: string): boolean | string;
+/**
+ * Retrieve a query parameter from a script URL in the browser.
+ *
+ * Usage:
+ *
+ * ```html
+ * <script src="https://example.com/example.js?test=hello&name=mazey"></script>
+ * ```
+ *
+ * ```javascript
+ * import { getScriptQueryParam } from "mazey";
+ *
+ * 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.
+ * @returns The decoded value of the specified query parameter, or an empty string if no matching parameter is found.
+ * @category URL
+ */
+declare function getScriptQueryParam(param: string, matchString?: string): string;
+/**
+ * Convert an object to a query string.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertObjectToQuery } from "mazey";
+ *
+ * const ret = convertObjectToQuery({ t1: "1", t2: "2", t3: "3", t4: "4" });
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * ?t1=1&t2=2&t3=3&t4=4
+ * ```
+ *
+ * @param obj - The object to convert to a query string.
+ * @returns The query string.
+ * @category URL
+ */
+declare function convertObjectToQuery(obj: {
+    [key: string]: string;
+}): string;
+/**
+ * Convert an HTTP URL to an HTTPS URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { convertHttpToHttps } from "mazey";
+ *
+ * const ret = convertHttpToHttps("http://example.com");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * https://example.com
+ * ```
+ *
+ * @param url - The HTTP URL to convert to HTTPS.
+ * @returns The HTTPS URL.
+ * @category URL
+ */
+declare function convertHttpToHttps(url: string): string;
+/**
+ * Alias of `convertHttpToHttps`.
+ *
+ * @hidden
+ */
+declare function replaceHttp(url: string): string;
+/**
+ * Get the host of the URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getUrlHost } from "mazey";
+ *
+ * const ret = getUrlHost("https://example.com/path/to/page");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * example.com
+ * ```
+ *
+ * @param url - The URL to get the host from.
+ * @returns The host of the URL.
+ * @category URL
+ */
+declare function getUrlHost(url: string): string;
+/**
+ * Get the path of the URL.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getUrlPath } from "mazey";
+ *
+ * const ret = getUrlPath("https://example.com/path/to/page");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * /path/to/page
+ * ```
+ *
+ * @param url - The URL to get the path from.
+ * @returns The path of the URL.
+ * @category URL
+ */
+declare function getUrlPath(url: string): string;
+/**
+ * Listen to URL changes from:
+ * - back/forward navigation
+ * - hash changes
+ * - history.pushState / history.replaceState
+ *
+ * @param callback - Called with current URL, previous URL, and trigger source.
+ * @param options - { fireOnInit?: boolean } default true.
+ * @returns unsubscribe function
+ *
+ * @category URL
+ */
+declare function onURLChange(callback: (info: URLChangeInfo) => void, options?: OnURLChangeOptions): () => void;
+
+/**
+ * Modify `class`: determine `class`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { hasClass, addClass, removeClass } from "mazey";
+ *
+ * const dom = document.querySelector("#box");
+ * // Determine `class`
+ * hasClass(dom, "test");
+ * // Add `class`
+ * addClass(dom, "test");
+ * // Remove `class`
+ * removeClass(dom, "test");
+ * ```
+ *
+ * @category DOM
+ */
+declare function hasClass(obj: MazeyElement, cls: string): boolean;
+/**
+ * Add `class` to the element. The second parameter can be a single class name or an array of class names.
+ *
+ * Basic Usage:
+ *
+ * ```javascript
+ * import { addClass } from "mazey";
+ *
+ * const ele = document.querySelector("#box");
+ * addClass(ele, "test");
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <div id="box" class="test"></div>
+ * ```
+ *
+ * Advanced Usage:
+ *
+ * ```javascript
+ * import { addClass, genBrowserAttrs } from "mazey";
+ *
+ * const ele = document.querySelector("html");
+ * addClass(ele, genBrowserAttrs());
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <html class="windows desktop webkit chrome"></html>
+ * ```
+ *
+ * @category DOM
+ */
+declare function addClass(ele: MazeyElement, cls: string | string[]): void;
+/**
+ * Alias of `addClass`.
+ *
+ * @hidden
+ */
+declare function setClass(ele: HTMLElement, cls: string): void;
+/**
+ * Modify `class`: remove `class`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { hasClass, addClass, removeClass } from "mazey";
+ *
+ * const dom = document.querySelector("#box");
+ * // Determine `class`
+ * hasClass(dom, "test");
+ * // Add `class`
+ * addClass(dom, "test");
+ * // Remove `class`
+ * removeClass(dom, "test");
+ * ```
+ *
+ * @category DOM
+ */
+declare function removeClass(obj: MazeyElement, cls: string): void;
+/**
+ * EN: Add `<style>` in `<head>`.
+ *
+ * ZH: 添加样式标签; style: 样式标签内的字符串; id: `<style>` 标签的 `id`; 返回: 添加成功/失败。
+ *
+ * Usage:
+ *
+ * Example 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
+ *
+ * ```javascript
+ * import { addStyle } from "mazey";
+ *
+ * addStyle(
+ *   "body { background-color: #333; }",
+ *   { id: "test" }
+ * );
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <style id="test">body { background-color: #333; }</style>
+ * ```
+ *
+ * Example 2: Add the `<style>` without `id`, and repeated invoking will add a new one.
+ *
+ * ```javascript
+ * import { addStyle } from "mazey";
+ *
+ * addStyle("body { background-color: #444; }");
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <style>body { background-color: #444; }</style>
+ * ```
+ *
+ * Example 3: Combine `genStyleString` and `addStyle` to add multiple styles at once.
+ *
+ * ```javascript
+ * import { genStyleString, addStyle } from "mazey";
+ *
+ * const xStyle = genStyleString(
+ *   ".footer>.x-wish>a:first-child" +
+ *   ",div.wish-flex>a[href^='https://github.com/chengchuu']" +
+ *   ",.m-hide",
+ *   [ "display: none" ]
+ * );
+ * const yStyle = genStyleString(
+ *   ".footer>.y-wish:before",
+ *   [
+ *     `content: 'Copyright (c) chengchuu'`,
+ *     "color: inherit",
+ *     "padding-inline-start: var(--y-wish-1_5)",
+ *     "padding-inline-end: var(--y-wish-1_5)",
+ *     "padding-top: var(--y-wish-1)",
+ *     "padding-bottom: var(--y-wish-1)",
+ *   ]
+ * );
+ * addStyle(xStyle + yStyle, { id: "z-style" });
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <style id="z-style">.footer>.x-wish>a:first-child,div.wish-flex>a[href^='https://github.com/chengchuu'],.m-hide{display: none;}.footer>.y-wish:before{content: 'Copyright (c) chengchuu';color: inherit;padding-inline-start: var(--y-wish-1_5);padding-inline-end: var(--y-wish-1_5);padding-top: var(--y-wish-1);padding-bottom: var(--y-wish-1);}</style>
+ * ```
+ *
+ * @category DOM
+ */
+declare function addStyle(style: string, options?: {
+    id?: string;
+}): boolean;
+/**
+ * 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.
+ *
+ * Usage:
+ *
+ * ```html
+ * <img src="image.jpg?width=100px&height=200px">
+ * ```
+ *
+ * ```javascript
+ * import { setImgSizeBySrc } from "mazey";
+ *
+ * setImgSizeBySrc();
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <img src="image.jpg?width=100px&height=200px" width="100px" height="200px">
+ * ```
+ *
+ * @returns {boolean} - Returns `true` if images were found and their dimensions were set, otherwise `false`.
+ * @category DOM
+ */
+declare function setImgSizeBySrc(): boolean;
+/**
+ * Alias of `setImgSizeBySrc`.
+ *
+ * @hidden
+ */
+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.
+ *
+ * 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;}
+ * ```
+ *
+ * Example: Combine `genStyleString` and `addStyle` to add multiple styles at once.
+ *
+ * ```javascript
+ * import { genStyleString, addStyle } from "mazey";
+ *
+ * const xStyle = genStyleString(
+ *   ".footer>.x-wish>a:first-child" +
+ *   ",div.wish-flex>a[href^='https://github.com/chengchuu']" +
+ *   ",.m-hide",
+ *   [ "display: none" ]
+ * );
+ * const yStyle = genStyleString(
+ *   ".footer>.y-wish:before",
+ *   [
+ *     `content: 'Copyright (c) chengchuu'`,
+ *     "color: inherit",
+ *     "padding-inline-start: var(--y-wish-1_5)",
+ *     "padding-inline-end: var(--y-wish-1_5)",
+ *     "padding-top: var(--y-wish-1)",
+ *     "padding-bottom: var(--y-wish-1)",
+ *   ]
+ * );
+ * addStyle(xStyle + yStyle, { id: "z-style" });
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <style id="z-style">.footer>.x-wish>a:first-child,div.wish-flex>a[href^='https://github.com/chengchuu'],.m-hide{display: none;}.footer>.y-wish:before{content: 'Copyright (c) chengchuu';color: inherit;padding-inline-start: var(--y-wish-1_5);padding-inline-end: var(--y-wish-1_5);padding-top: var(--y-wish-1);padding-bottom: var(--y-wish-1);}</style>
+ * ```
+ *
+ * @param {string} selector
+ * @param {array} styleArray
+ * @returns {string} The inline style string.
+ * @category DOM
+ */
+declare function genStyleString(selector: string, styleArray: Array<string>): string;
+/**
+ * Get the value of the meta tag by the given name.
+ *
+ * Usage:
+ *
+ * ```html
+ * <meta name="keywords" content="mazey,web,frontend">
+ * ```
+ *
+ * ```javascript
+ * import { getPageMeta } from "mazey";
+ *
+ * const keywords = getPageMeta("keywords");
+ * console.log(keywords);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * mazey,web,frontend
+ * ```
+ *
+ * @param {string} name - The name of the meta tag.
+ * @returns {string} The content of the meta tag.
+ * @category DOM
+ */
+declare function getPageMeta(name: string): string;
+
+/**
+ * Prevent bubbling.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { cancelBubble } from "mazey";
+ *
+ * const ret1 = cancelBubble(e);
+ * ```
+ *
+ * @category Event
+ */
+declare function cancelBubble(e: Event): void;
+/**
+ * Get the defined listeners.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getDefineListeners } from "mazey";
+ *
+ * const ret = getDefineListeners();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * {}
+ * ```
+ *
+ * @category Event
+ * @hidden
+ */
+declare function getDefineListeners(): DefineListeners;
+/**
+ * Add event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { addEvent } from "mazey";
+ *
+ * addEvent("test", (e) => {
+ *  console.log("test event:", e);
+ * });
+ * fireEvent("test");
+ * ```
+ *
+ * Output:
+ *
+ * ```javascript
+ * test event: { type: "test" }
+ * ```
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+declare function addEvent(type: string, fn: MazeyFn): void;
+/**
+ * Fire/Invoke event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { fireEvent } from "mazey";
+ *
+ * fireEvent("test");
+ * ```
+ *
+ * @param type The event type.
+ * @param params The event parameters.
+ * @category Event
+ */
+declare function fireEvent(type: string, params?: MazeyObject): void;
+/**
+ * Alias of `fireEvent`.
+ *
+ * @hidden
+ */
+declare function invokeEvent(type: string): void;
+/**
+ * Remove event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { removeEvent } from "mazey";
+ *
+ * removeEvent("test");
+ * ```
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+declare function removeEvent(type: string, fn: MazeyFn): void;
+
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
+ *
+ * setSessionStorage("test", "123");
+ * const ret1 = getSessionStorage("test");
+ * setLocalStorage("test", "123");
+ * const ret2 = getLocalStorage("test");
+ * console.log(ret1, ret2);
+ *
+ * // or package in usage
+ * const projectName = "mazey";
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {void} 返回值
+ * @category Store
+ */
+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。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
+ *
+ * setSessionStorage("test", "123");
+ * const ret1 = getSessionStorage("test");
+ * setLocalStorage("test", "123");
+ * const ret2 = getLocalStorage("test");
+ * console.log(ret1, ret2);
+ *
+ * // or package in usage
+ * const projectName = "mazey";
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {any} 返回值
+ * @category Store
+ */
+declare function getSessionStorage<T>(key: string): T | null;
+/**
+ * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
+ *
+ * ZH: 存储/获取数据到 sessionStorage/localStorage。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
+ *
+ * setSessionStorage("test", "123");
+ * const ret1 = getSessionStorage("test");
+ * setLocalStorage("test", "123");
+ * const ret2 = getLocalStorage("test");
+ * console.log(ret1, ret2);
+ *
+ * // or package in usage
+ * const projectName = "mazey";
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {void} 返回值
+ * @category Store
+ */
+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。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from "mazey";
+ *
+ * setSessionStorage("test", "123");
+ * const ret1 = getSessionStorage("test");
+ * setLocalStorage("test", "123");
+ * const ret2 = getLocalStorage("test");
+ * console.log(ret1, ret2);
+ *
+ * // or package in usage
+ * const projectName = "mazey";
+ * function mSetLocalStorage (key, value) {
+ *   return setLocalStorage(`${projectName}_${key}`, value);
+ * }
+ *
+ * function mGetLocalStorage (key) {
+ *   return getLocalStorage(`${projectName}_${key}`);
+ * }
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123 123
+ * ```
+ *
+ * @param {string} key 键
+ * @returns {void} 返回值
+ * @category Store
+ */
+declare function getLocalStorage<T>(key: string): T | null;
+/**
+ * EN: Handle Cookie.
+ *
+ * ZH: 设置/获取 Cookie。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setCookie, getCookie } from "mazey";
+ *
+ * setCookie("test", "123", 30, "example.com"); // key value day domain
+ * const ret = getCookie("test");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123
+ * ```
+ *
+ * @category Store
+ */
+declare function getCookie(name: string): string;
+/**
+ * EN: Handle Cookie.
+ *
+ * ZH: 设置/获取 Cookie。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { setCookie, getCookie } from "mazey";
+ *
+ * setCookie("test", "123", 30, "example.com"); // key value day domain
+ * const ret = getCookie("test");
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 123
+ * ```
+ *
+ * @category Store
+ */
+declare function setCookie(name: string, value: string, days?: number, domain?: string): void;
+/**
+ * Delete a cookie by name.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { removeCookie } from "mazey";
+ *
+ * const ret = removeCookie("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 Store
+ */
+declare function removeCookie(name: string): boolean;
+/**
+ * Alias of `removeCookie`.
+ *
+ * @hidden
+ */
+declare function delCookie(name: string): void;
+
+/**
+ * EN: Load a CSS file from the server.
+ *
+ * ZH: 动态加载 CSS 文件。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { loadCSS } from "mazey";
+ *
+ * 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}`)
+ *     }
+ *   );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * Load CSS Success: loaded
+ * ```
+ *
+ * @param {string} url -- css资源路径
+ * @param {string} options.id -- link标签id
+ * @returns {Promise<string>} true -- 加载成功
+ * @category Load
+ */
+declare function loadCSS(url: string, options?: {
+    id?: string;
+}): Promise<unknown>;
+/**
+ * EN: Load a JavaScript file from the server and execute it.
+ *
+ * ZH: 动态加载 JavaScript 文件。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { loadScript } from "mazey";
+ *
+ * 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`
+ *     }
+ *   )
+ *   .then(
+ *     res => {
+ *       console.log(`Load JavaScript script: ${res}`);
+ *     }
+ *   )
+ *   .catch(
+ *     err => {
+ *       console.error(`Load JavaScript script: ${err.message}`);
+ *     }
+ *   );
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * Load JavaScript script: loaded
+ * ```
+ *
+ * @param {string} url -- JavaScript 资源路径
+ * @param {string} options.id -- DOM ID
+ * @param {function} options.callback -- 加载后回调函数
+ * @param {number} options.timeout -- 超时时长
+ * @param {boolean} options.isDefer -- 是否添加 defer 标签
+ * @param {boolean} options.isAsync -- 是否添加 async 标签
+ * @param {boolean} options.isCrossOrigin -- 是否跨域
+ * @param {object} options.attributes -- 其他属性
+ * @param {string} options.cssUrl -- CSS 资源路径
+ * @returns {Promise<string>} -- true 成功
+ * @category Load
+ */
+declare function loadScript(url: string, options?: {
+    id?: string;
+    callback?: (...params: MazeyFnParams) => MazeyFnReturn;
+    timeout?: number;
+    isDefer?: boolean;
+    isAsync?: boolean;
+    isCrossOrigin?: boolean;
+    attributes?: Record<string, string> | null;
+    cssUrl?: string;
+}): LoadScriptReturns;
+/**
+ * EN: Check whether the page is loaded successfully (Keep the compatibility if the browser's `load` event has been triggered).
+ *
+ * ZH: 页面加载完成。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { windowLoaded } from "mazey";
+ *
+ * windowLoaded()
+ *   .then(res => {
+ *     console.log(`Load Success: ${res}`);
+ *   })
+ *   .catch(err => {
+ *     console.log(`Load Timeout or Fail: ${err.message}`);
+ *   });
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * Load Success: load
+ * ```
+ *
+ * @param {number} timeout 超时时间 / 单位：毫秒，默认：30000(30 秒)
+ * @returns {Promise<string>} document is loaded? "complete" "load" / "timeout"
+ * @category Load
+ */
+declare function windowLoaded(timeout?: number): Promise<string | Error>;
+/**
+ * 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.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { loadImage } from "mazey";
+ *
+ * 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
+ */
+declare function loadImage(url: string): Promise<HTMLImageElement>;
+/**
+ * Load a script from the given URL if it (`window["attribute"]`) has not already been loaded.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { loadScriptIfUndefined } from "mazey";
+ *
+ * loadScriptIfUndefined("xyz", "https://example.com/lib/xyz.min.js")
+ *   .then(() => {
+ *     console.log("xyz is loaded.");
+ *   })
+ *   .catch(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.
+ * @category Load
+ */
+declare function loadScriptIfUndefined(windowAttribute: string, url: string): LoadScriptReturns;
+
+/**
+ * @hidden
+ */
+declare function isSupportedEntryType(name: string): boolean;
+/**
+ * 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
+ * import { getFCP } from "mazey";
+ *
+ * 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 Perf
+ */
+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
+ * import { getFP } from "mazey";
+ *
+ * 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 Perf
+ */
+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
+ * import { getLCP } from "mazey";
+ *
+ * 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 Perf
+ */
+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
+ * import { getFID } from "mazey";
+ *
+ * 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 Perf
+ */
+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
+ * import { getCLS } from "mazey";
+ *
+ * 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 Perf
+ */
+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
+ * import { getTTFB } from "mazey";
+ *
+ * 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 Perf
+ */
+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://github.com/chengchuu/mazey/releases/tag/v3.9.7)).
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getPerformance } from "mazey";
+ *
+ * // `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:
+ *
+ * ```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}
+ * ```
+ *
+ * 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 Perf
+ */
+declare function getPerformance(camelCase?: boolean): Promise<WebPerformance | Error>;
+
+/**
+ * EN: Detect the margin of Safety. Determine if it is a secure PWA environment that it can run.
+ *
+ * ZH: 判断是否是安全的 PWA 环境。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isSafePWAEnv } from "mazey";
+ *
+ * const ret = isSafePWAEnv();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * @environment Browser
+ * @returns {boolean} true 是
+ * @category Browser Information
+ */
+declare function isSafePWAEnv(): boolean;
+/**
+ * EN: Provides detailed information about the browser.
+ *
+ * ZH: 返回有关浏览器的详细信息。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { getBrowserInfo } from "mazey";
+ *
+ * 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"}
+ * ```
+ *
+ * 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 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.
+ *
+ * ```javascript
+ * const { system, shell } = getBrowserInfo();
+ * const isMobileQQ = ["android", "ios"].includes(system) && ["qq_browser", "qq_app"].includes(shell);
+ * ```
+ *
+ * @environment Browser
+ * @returns Browser information
+ * @category Browser Information
+ */
+declare function getBrowserInfo(): BrowserInfo;
+/**
+ * EN: Generate browser attributes.
+ *
+ * ZH: 生成浏览器属性。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { genBrowserAttrs } from "mazey";
+ *
+ * const attrs = genBrowserAttrs();
+ * console.log(attrs);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * ["windows", "desktop", "webkit", "chrome"]
+ * ```
+ *
+ * @environment Browser
+ * @param {string} prefix
+ * @returns {array} Browser attributes
+ * @category Browser Information
+ */
+declare function genBrowserAttrs(prefix?: string, separator?: string): string[];
+/**
+ * Detect webp support.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { isSupportWebp } from "mazey";
+ *
+ * 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
+ */
+declare function isSupportWebp(): Promise<boolean>;
+
+/**
+ * EN: Custom console printing (`console`).
+ *
+ * ZH: 生成自定义控制台打印。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * import { genCustomConsole } from "mazey";
+ *
+ * const cusConsole = genCustomConsole("[MazeyLog]");
+ * cusConsole.log("I am string.");
+ * cusConsole.info("I am boolean.", true);
+ * cusConsole.info("I am number.", 123, 456);
+ * cusConsole.info("I am object.", { a: 123, b: 456});
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * [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 The prefix string.
+ * @param {object} options The options object.
+ * @param {boolean} options.enabled Whether logging is enabled.
+ * @param {boolean} options.isClosed Deprecated, Use "enabled" instead.
+ * @param {boolean} options.showWrap Whether to show the wrap.
+ * @param {boolean} options.showDate Whether to show the date.
+ * @param {string} options.locales A locale string.
+ * @param {boolean} options.isStringifyObject Whether to stringify the object.
+ * @param {function} options.logFn The function with Log.
+ * @param {function} options.errorFn The function with Error.
+ * @returns {object} The custom console object.
+ * @category Debug
+ */
+declare function genCustomConsole(prefix?: string, options?: {
+    enabled?: boolean;
+    isClosed?: boolean;
+    showWrap?: boolean;
+    showDate?: boolean;
+    locales?: string;
+    isStringifyObject?: boolean;
+    logFn?: () => void;
+    errorFn?: () => void;
+}): Console;
+/**
+ * @hidden
+ */
+declare const mazeyCon: Console;
+/**
+ * EN: Print logs with Time.
+ *
+ * ZH: 打印带有时间的日志。
+ *
+ * Usage:
+ *
+ * ```javascript
+ * timeCon("I am string.");
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 2024年11月2日周六 09:24:40 I am string.
+ * ```
+ *
+ * @hidden
+ */
+declare const timeCon: Console;
+
+export { addClass, addEvent, addStyle, calLongestCommonSubsequence, calLongestCommonSubstring, camelCase2Underscore, camelCaseToKebabCase, cancelBubble, clearHTML, clearHtml, convert10To26, convertCamelToKebab, convertCamelToUnder, convertHttpToHttps, convertKebabToCamel, convertObjectToQuery, convertToHtmlBreaks, convertUnderToCamel, cutCHSString, cutZHString, debounce, deepCopy, deepCopyObject, delCookie, doFn, fireEvent, floatFixed, floatToPercent, formatDate, genBrowserAttrs, genCustomConsole, genHashCode, genRndNumString, genStyleString, genUniqueNumString, generateRndNum, generateUniqueNum, getAllQueryParams, getBrowserInfo, getCLS, getCookie, getCurrentVersion, getDefineListeners, getDomain, getFCP, getFID, getFP, getFileSize, getFriendlyInterval, getHashQueryParam, getLCP, getLocalStorage, getPageMeta, getPerformance, getQueryParam, getScriptQueryParam, getSessionStorage, getTTFB, getUrlFileType, getUrlHost, getUrlParam, getUrlPath, hasClass, inRate, invokeEvent, invokeFn, isArray, isBool, isBoolean, isBrowser, isFunction, isHit, isJSONString, isJsonString, isNonEmptyArray, isNonEmptyObject, isNumber, isPureObject, isSafePWAEnv, isString, isSupportWebp, isSupportedEntryType, isUdfOrNul, isValidData, isValidEmail, isValidHttpUrl, isValidPhoneNumber, isValidUrl, loadCSS, loadImage, loadScript, loadScriptIfUndefined, longestComSubsequence, longestComSubstring, mNow, mTrim, mazeyCon, newLine, onURLChange, removeClass, removeCookie, removeEvent, removeHTML, removeHtml, repeatUntilConditionMet, replaceHttp, sanitizeInput, setClass, setCookie, setImgSizeBySrc, setImgWidHeiBySrc, setLocalStorage, setSessionStorage, sleep, throttle, timeCon, truncateZHString, unsanitize, unsanitizeInput, updateQueryParam, waitTime, windowLoaded, zAxiosIsValidRes };