mazey 3.3.11 → 3.3.12

package/lib/index.d.ts

@@ -3,8 +3,16 @@
  *
  * ZH: 计算两个字符串的最长公共子串
  *
+ * Usage:
+ *
+ * ```
+ * calLongestCommonSubstring('fish', 'finish');
+ * ```
+ *
+ * Output:
+ *
  * ```
- * calLongestCommonSubstring('fish', 'finish'); // 3
+ * 3
  * ```
  *
  * @param {string} aStr String
@@ -17,8 +25,16 @@ export declare function calLongestCommonSubstring(aStr: string, bStr: string): n
  *
  * ZH: 计算两个字符串的最长公共子序列
  *
+ * Usage:
+ *
+ * ```
+ * calLongestCommonSubsequence('fish', 'finish');
+ * ```
+ *
+ * Output:
+ *
  * ```
- * calLongestCommonSubsequence('fish', 'finish'); // 4
+ * 4
  * ```
  *
  * @param {string} aStr 字符串
@@ -27,23 +43,49 @@ export declare function calLongestCommonSubstring(aStr: string, bStr: string): n
  */
 export declare function calLongestCommonSubsequence(aStr: string, bStr: string): number;
 /**
- * @method getQueryParam
- * @description Get the query param's value of the current Web URL(`location.search`).
+ * Get the query param's value of the current Web URL(`location.search`).
+ *
+ * ```
+ * // http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
+ * // ?t1=1&t2=2&t3=3&t4=4
+ * getQueryParam('t3'); // 3
+ * getQueryParam('t4'); // 4
+ * ```
+ *
  * @param {string} param Query param.
  * @returns {string} value
  */
 export declare function getQueryParam(param: string): string;
 /**
- * @method getUrlParam
- * @description Get the query param's value of the input URL.
+ * Get the query param's value of the input URL.
+ *
+ * ```
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // 3
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // 4
+ * ```
+ *
  * @param {string} url URL string.
  * @param {string} param Query param.
  * @returns {string} value
  */
 export declare function getUrlParam(url: string, param: string): string | string[];
 /**
- * @method updateQueryParam
- * @description Update the query param's value of the input URL.
+ * Update the query param's value of the input URL.
+ *
+ * Usage:
+ *
+ * ```
+ * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three');
+ * updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * http://example.com/?t1=1&t2=2&t3=three&t4=4
+ * http://example.com/?t1=1&t2=2&t3=3&t4=four
+ * ```
+ *
  * @param {string} url URL string.
  * @param {string} param Query param.
  * @param {string} value Param's value.
@@ -51,36 +93,81 @@ export declare function getUrlParam(url: string, param: string): string | string
  */
 export declare function updateQueryParam(url: string, param: string, value: string): string;
 /**
- * @method getHashQueryParam
- * @description Get the hash query param's value of the current Web URL(`location.hash`).
+ * Get the hash query param's value of the current Web URL(`location.hash`).
+ *
+ * Usage:
+ *
+ * ```
+ * // http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
+ * // #2333?t1=1&t2=2&t3=3&t4=4
+ * getHashQueryParam('t3');
+ * getHashQueryParam('t4');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * 3
+ * 4
+ * ```
+ *
  * @param {string} param Query param.
  * @returns {string} value
  */
 export declare function getHashQueryParam(param: string): string;
 /**
- * @method getDomain
- * @description Get the domain of URL, and other params.
+ * Get the domain of URL, and other params.
+ *
+ * Usage:
+ *
+ * ```
+ * getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
+ * getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * example.com
+ * example.com/test/thanks
+ * ```
+ *
  * @param {string} url
  * @param {array} rules Object.keys(location), ['href', 'protocol', 'host', 'hostname', 'port', 'pathname', 'search', 'hash'], ['hostname', 'pathname'] = 'km.mazey.net/plugins/servlet/mobile'
  */
 export declare function getDomain(url: string, rules?: string[]): string;
 /**
- * @method camelCaseToKebabCase
- * @description Transfer CamelCase to KebabCase.
+ * Transfer CamelCase to KebabCase.
+ *
+ * ```
+ * camelCaseToKebabCase('ABC'); // a-b-c
+ * camelCaseToKebabCase('aBC'); // a-b-c
+ * ```
+ *
  * @param {string} camelCase 'aBC' or 'ABC'
  * @returns {string} 'a-b-c'
  */
 export declare function camelCaseToKebabCase(camelCase: string): string;
 /**
- * @method camelCase2Underscore
- * @description Transfer CamelCase to Underscore.
+ * Transfer CamelCase to Underscore.
+ *
+ * ```
+ * camelCase2Underscore('ABC'); // a_b_c
+ * camelCase2Underscore('aBC'); // a_b_c
+ * ```
+ *
  * @param {string} camelCase 'aBC' or 'ABC'
  * @returns {string} 'a_b_c'
  */
 export declare function camelCase2Underscore(camelCase: string): string;
 /**
- * @method mTrim
- * @description Remove leading and trailing whitespace or specified characters from string.
+ * Remove leading and trailing whitespace or specified characters from string.
+ *
+ * ```
+ * mTrim(' 1 2 3 '); // '1 2 3'
+ * mTrim('abc '); // 'abc'
+ * ```
+ *
  * @param {string} str The string to trim.
  * @returns {string} Trimmed string.
  */
@@ -93,17 +180,42 @@ export declare function mTrim(str: string): string;
  */
 export declare function newLine(str: string): string;
 /**
- * @method deepCopyObject
- * @description Clone Object deeply.
+ * Clone Object deeply.
+ *
+ * Usage:
+ *
+ * ```
+ * deepCopyObject(['a', 'b', 'c']);
+ * deepCopyObject('abc');
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * ['a', 'b', 'c']
+ * 'abc'
+ * ```
+ *
  * @param {object} obj The value to clone.
  * @returns {object} Returns the deep cloned value.
  */
 export declare function deepCopyObject(obj: any): any;
 /**
- * @method isJsonString
- * @description Check whether it is a valid JSON string.
- * @param {string} str The string to check.
- * @returns {boolean} Return the result of checking.
+ * Check whether it is a valid JSON string.
+ *
+ * Usage:
+ *
+ * ```
+ * isJsonString(`['a', 'b', 'c']`);
+ * isJsonString(`["a", "b", "c"]`);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * false
+ * true
+ * ```
  */
 export declare function isJsonString(str: string): boolean;
 /**
@@ -153,6 +265,12 @@ export declare function removeClass(obj: any, cls: string): void;
  *
  * ZH: 节流
  *
+ * ```
+ * const foo = throttle(() => {
+ *   console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
+ * }, 1000, { leading: true });
+ * ```
+ *
  * Reference: [Lodash](https://lodash.com/docs/4.17.15#throttle)
  */
 export declare function throttle(func: any, wait: number, options?: {
@@ -164,8 +282,6 @@ export declare function throttle(func: any, wait: number, options?: {
  *
  * ZH: 去抖
  *
- * Usage:
- *
  * ```
  * const foo = debounce(() => {
  *   console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
@@ -185,8 +301,20 @@ export declare function friendlyInterval(start?: number, end?: number, options?:
     type?: string;
 }): number | string;
 /**
- * @method isNumber
- * @description 判断是否有效数字
+ * EN: Check whether it is a right number.
+ *
+ * ZH: 判断是否有效数字
+ *
+ * ```
+ * isNumber(123); // true
+ * isNumber('123'); // false
+ * // Default: NaN, Infinity is not Number
+ * isNumber(Infinity); // false
+ * isNumber(Infinity, { isUnFiniteAsNumber: true }); // true
+ * isNumber(NaN); // false
+ * isNumber(NaN, { isNaNAsNumber: true, isUnFiniteAsNumber: true }); // true
+ * ```
+ *
  * @param {*} num 被判断的值
  * @param {boolean} options.isNaNAsNumber 是否 NaN 算数字（默认不算）
  * @param {boolean} options.isUnFiniteAsNumber 是否 无限 算数字（默认不算）
@@ -231,8 +359,29 @@ export declare function setLocalStorage(key: string, value?: any): void;
  */
 export declare function getLocalStorage(key: string): any;
 /**
- * @method loadCSS
- * @description 动态加载css文件
+ * EN: Load a CSS file from the server.
+ *
+ * ZH: 动态加载 CSS 文件
+ *
+ * ```
+ * loadCSS(
+ *     'http://example.com/css/mazey-base.css',
+ *     {
+ *       id: 'iamid', // Optional, link ID, default none
+ *     }
+ *   )
+ *   .then(
+ *     res => {
+ *       console.log(`Load CSS Success: ${res}`);
+ *     }
+ *   )
+ *   .catch(
+ *     err => {
+ *       console.error(`Load CSS Fail: ${err.message}`)
+ *     }
+ *   );
+ * ```
+ *
  * @param {string} url -- css资源路径
  * @param {string} options.id -- link标签id
  * @returns {Promise<boolean>} true -- 加载成功
@@ -241,9 +390,32 @@ export declare function loadCSS(url: string, options?: {
     id?: string;
 }): Promise<boolean | Error | any>;
 /**
- * @method loadScript
- * @description 动态加载js文件
- * @param {string} url -- js资源路径
+ * EN: Load a JavaScript file from the server and execute it.
+ *
+ * ZH: 动态加载 JavaScript 文件
+ *
+ * ```
+ * loadScript(
+ *     'http://example.com/static/js/plugin-2.1.1.min.js',
+ *     {
+ *       id: 'iamid', // (Optional) script ID, default none
+ *       timeout: 5000, // (Optional) timeout, default `5000`
+ *       isDefer: false, // (Optional) defer, default `false`
+ *     }
+ *   )
+ *   .then(
+ *     res => {
+ *       console.log(`Load JavaScript script: ${res}`);
+ *     }
+ *   )
+ *   .catch(
+ *     err => {
+ *       console.error(`Load JavaScript script: ${err.message}`)
+ *     }
+ *   );
+ * ```
+ *
+ * @param {string} url -- JavaScript 资源路径
  * @param {string} options.id -- DOM ID
  * @param {function} options.callback -- 加载后回调函数
  * @param {number} options.timeout -- 超时时长
@@ -275,22 +447,102 @@ interface WebPerformance {
     [key: string]: string | number;
 }
 /**
- * @method getPerformance
- * @description 获取页面加载相关的各项数据
+ * EN: Get page load time(PerformanceTiming).
+ *
+ * ZH: 获取页面加载相关的各项数据
+ *
+ * Usage:
+ *
+ * ```
+ * // `camelCase：true`(Default) Return hump data.
+ * // `camelCase：false` Return underline data.
+ * getPerformance(true)
+ *  .then(res => {
+ *   console.log(JSON.stringify(res));
+ *  })
+ *  .catch(console.error);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * {"deviceType":"pc","network":"3g","unloadTime":0,"redirectTime":0,"dnsTime":0,"tcpTime":0,"responseTime":65,"downloadTime":1,"domreadyTime":369,"onloadTime":441,"whiteTime":94,"renderTime":441,"decodedBodySize":210,"encodedBodySize":210}
+ * ```
+ *
+ * Results:
+ *
+ * | Index | Field | Description |
+ * | --- | --- | --- |
+ * | DNS lookup | dns_time | domainLookupEnd - domainLookupStart |
+ * | Connection negotiation | tcp_time | connectEnd - connectStart |
+ * | Requests and responses | response_time | responseStart - requestStart |
+ * | White screen | white_time | responseStart - navigationStart |
+ * | DomReady | domready_time  | domContentLoadedEventStart - navigationStart |
+ * | Onload | onload_time | loadEventStart - navigationStart |
+ * | EventEnd | render_time | loadEventEnd -navigationStart |
+ * | Unload | unload_time | (Optional) unloadEventEnd - unloadEventStart |
+ * | Redirect | redirect_time | (Optional) redirectEnd - redirectStart |
+ * | SSL | ssl_time | (Optional) connectEnd - secureConnectionStart |
+ * | Download | download_time | (Optional) responseEnd - responseStart |
+ *
  * @param {boolean} camelCase -- true（默认） 以驼峰形式返回数据 false 以下划线形式返回数据
  * @returns {Promise<object>} 加载数据
  */
 export declare function getPerformance(camelCase?: boolean): Promise<WebPerformance | Error>;
 /**
- * @method inRate
- * @description 百分位概率
+ * EN: Hit probability (1% ~ 100%).
+ *
+ * ZH: 百分位概率
+ *
+ * Usage:
+ *
+ * ```
+ * inRate(0.5); // 0.01 ~ 1 true/false
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * true
+ * ```
+ *
+ * Example: Test the precision.
+ *
+ * ```
+ * // Test
+ * let trueCount = 0;
+ * let falseCount = 0;
+ * new Array(1000000).fill(0).forEach(() => {
+ *   if (inRate(0.5)) {
+ *     trueCount++;
+ *   } else {
+ *     falseCount++;
+ *   }
+ * });
+ * console.log(trueCount, falseCount); // 499994 500006
+ * ```
+ *
  * @param {number} rate -- 0.1 ~ 1 => 1% ~ 100%
  * @returns {boolean} true 命中
  */
 export declare function inRate(rate: number): boolean;
 /**
- * @method isSafePWAEnv
- * @description 判断是否是安全的 PWA 环境
+ * EN: Determine if it is a secure PWA environment that it can run.
+ *
+ * ZH: 判断是否是安全的 PWA 环境
+ *
+ * Usage:
+ *
+ * ```
+ * isSafePWAEnv();
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * true
+ * ```
+ *
  * @returns {boolean} true 是
  */
 export declare function isSafePWAEnv(): boolean;
@@ -299,10 +551,20 @@ export declare function isSafePWAEnv(): boolean;
  *
  * ZH: 返回浏览器信息 https://github.com/JowayYoung/juejin-code/blob/master/browser-type.js
  *
+ * Usage:
+ *
+ * ```
+ * getBrowserInfo();
+ * ```
+ *
+ * Output:
+ *
  * ```
- * getBrowserInfo(); // {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
+ * {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
  * ```
  *
+ * Results:
+ *
  * | Index | Field | Description |
  * | --- | --- | --- |
  * | System | system | android, ios, windows, macos, linux |
@@ -313,7 +575,7 @@ export declare function isSafePWAEnv(): boolean;
  * | Supporter | supporter | edge, opera, chrome, safari, firefox, iexplore |
  * | Supporter version | supporterVs | - |
  * | Shell | shell | (Optional) wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
- * | Shell version | shellVs | (Optional) |
+ * | Shell version | shellVs | (Optional) 20/... |
  * | Apple device type | appleType | (Optional) iphone, ipad, ipod, iwatch |
  *
  * Example: Determine the environment of the mobile QQ.
@@ -354,8 +616,20 @@ export declare function clearHtml(str: string): string;
  */
 export declare function cutCHSString(str: string, len: number, hasDot?: boolean): string;
 /**
- * @method windowLoaded
- * @description 页面加载完成
+ * EN: Check whether the page is loaded successfully (Keepe the compatibility in case that browser's `load` event has been triggered).
+ *
+ * ZH: 页面加载完成
+ *
+ * ```
+ * windowLoaded(30) // second
+ *   .then(res => {
+ *     console.log(`Load Success: ${res}`); // Load Success: load
+ *   })
+ *   .catch(err => {
+ *     console.log(`Load Timeout or Fail: ${err.message}`);
+ *   });
+ * ```
+ *
  * @param {number} timeout 超时时间 / 单位：秒
  * @returns {Promise<string>} document is loaded? 'complete' 'load' / 'timeout'
  */
@@ -410,7 +684,28 @@ export declare function addStyle(style: string, options?: {
     id?: string;
 }): boolean;
 /**
- * 生成自定义控制台打印
+ * EN: Custom console printing (`console`).
+ *
+ * ZH: 生成自定义控制台打印
+ *
+ * Usage:
+ *
+ * ```
+ * const myConsole = genCustomConsole('MazeyLog:');
+ * myConsole.log('I am string.');
+ * myConsole.info('I am boolean.', true);
+ * myConsole.info('I am number.', 123, 456);
+ * myConsole.info('I am object.', { a: 123, b: 456});
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * MazeyLog: I am string.
+ * MazeyLog: I am boolean. true
+ * MazeyLog: I am number. 123 456
+ * MazeyLog: I am object. {a: 123, b: 456}
+ * ```
  *
  * @param {string} prefix 前缀
  * @param {string} locales A locale string.

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAqB5E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,MAAM,CA8BR;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAmBzE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,MAAM,CAQR;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,WAAe,GAAG,MAAM,CAOnE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQzC;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM3C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CASjD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAI,GAAG,MAAM,CAM5C;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAI,GAAG,MAAM,CAG/C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAQ/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,SAAI,GAAG,MAAM,CAExD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CASzC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CASvD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CASpD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAQvD;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,GAAG,EACT,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAO,GACtD,GAAG,CA0CL;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,CAkCtE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,SAAI,EACT,GAAG,SAAI,EACP,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAkB,GACzC,MAAM,GAAG,MAAM,CA4BjB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,GAAG,EAAE,GAAG,EACR,OAAO,GAAE;IAAE,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAG/D,GACA,OAAO,CAqBT;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAMnD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,GAAU,GAAG,IAAI,CAItE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CASlD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,GAAU,GAAG,IAAI,CAIpE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAShD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAe,GACpC,OAAO,CAAC,OAAO,GAAG,KAAK,GAAG,GAAG,CAAC,CAsHhC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IACP,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAQlB,GACA,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,CAgDnC;AAED;;;GAGG;AACH,wBAAgB,IAAI,IAAI,MAAM,CAQ7B;AAED;;;GAGG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,IAAI,CAsCN;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,SAAS,UAAO,GACf,OAAO,CAAC,cAAc,GAAG,KAAK,CAAC,CAsPjC;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAK5C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAyCtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,cAAc,IAAI;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAqLA;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,MAAM,CA4B7E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAK,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAe,GACpC,OAAO,CAiCT;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,SAAK,EACX,OAAO,GAAE;IACP,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CAQtB,GACA,OAAO,CAoFT;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,OAAO,GAAE;IACP,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;CAIrB,GACA,OAAO,CAyBT;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,CAMnD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAiBhD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAahD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAU/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAqB5E;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,MAAM,CA8BR;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAmBzE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,WAAe,GAAG,MAAM,CAOnE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQzC;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM3C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAE5C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CASjD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAI,GAAG,MAAM,CAM5C;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAI,GAAG,MAAM,CAG/C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAQ/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,SAAI,GAAG,MAAM,CAExD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CASzC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CASvD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CASpD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAQvD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,GAAG,EACT,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAO,GACtD,GAAG,CA0CL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,CAkCtE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,SAAI,EACT,GAAG,SAAI,EACP,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAkB,GACzC,MAAM,GAAG,MAAM,CA4BjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,QAAQ,CACtB,GAAG,EAAE,GAAG,EACR,OAAO,GAAE;IAAE,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAG/D,GACA,OAAO,CAqBT;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAMnD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,GAAU,GAAG,IAAI,CAItE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CASlD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,GAAU,GAAG,IAAI,CAIpE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAShD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,OAAO,CACrB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAe,GACpC,OAAO,CAAC,OAAO,GAAG,KAAK,GAAG,GAAG,CAAC,CAsHhC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IACP,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAQlB,GACA,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,CAgDnC;AAED;;;GAGG;AACH,wBAAgB,IAAI,IAAI,MAAM,CAQ7B;AAED;;;GAGG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,IAAI,CAsCN;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,cAAc,CAC5B,SAAS,UAAO,GACf,OAAO,CAAC,cAAc,GAAG,KAAK,CAAC,CAsPjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAK5C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAyCtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,cAAc,IAAI;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAqLA;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,MAAM,CA4B7E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAK,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAe,GACpC,OAAO,CAiCT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,SAAK,EACX,OAAO,GAAE;IACP,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CAQtB,GACA,OAAO,CAoFT;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,OAAO,GAAE;IACP,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;CAIrB,GACA,OAAO,CAyBT;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,CAMnD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAiBhD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAahD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAU/C"}

package/lib/index.esm.js

@@ -1,5 +1,5 @@
 /*!
- * mazey v3.3.11
+ * mazey v3.3.12
  * (c) 2018-2022 Mazey Chu
  * Released under the MIT License.
  */

package/lib/mazey.min.js

@@ -1,5 +1,5 @@
 /*!
- * mazey v3.3.11
+ * mazey v3.3.12
  * (c) 2018-2022 Mazey Chu
  * Released under the MIT License.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "3.3.11",
+  "version": "3.3.12",
   "description": "Mazey's library for front-end.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
@@ -82,6 +82,7 @@
     "husky": "^4.3.8",
     "jest": "^27.5.1",
     "lint-staged": "^10.0.8",
+    "markdown-toc": "^1.2.0",
     "prettier": "^1.19.1",
     "prettier-eslint-cli": "^5.0.0",
     "rollup": "^2.79.1",

package/scripts/build-helper.js

@@ -3,6 +3,8 @@
 const path = require('path');
 const _resolve = (_path) => path.resolve(__dirname, _path);
 const format = require('date-fns/format');
+const toc = require('markdown-toc');
+const fs = require('fs');
 // Generate version: 20210308.072903
 const genVersion = () => {
   const d = new Date();
@@ -11,7 +13,47 @@ const genVersion = () => {
 };
 const version = genVersion();
 
+const generateToc = () => {
+  console.log('Generating Table of Contents...');
+  const RMFilePath = _resolve('../README.md');
+  // https://melvingeorge.me/blog/get-all-the-contents-from-file-as-string-nodejs
+  console.log('running...');
+  const buffer = fs.readFileSync(RMFilePath);
+  const fileContent = buffer.toString();
+  // https://github.com/jonschlinkert/markdown-toc
+  const removeUnnecessaryHeadings = (str) => {
+    return ![
+      'mazey',
+      'Install',
+      'Usage',
+      'Contributing',
+      'License',
+      'API Examples',
+    ].some(v => {
+      return str.includes(v);
+    });
+  };
+  let tocContent = toc(fileContent, {
+    filter: removeUnnecessaryHeadings,
+    bullets: ['-', '*'],
+  }).content;
+  tocContent = tocContent.replace(/[ ]{4}/gm, '');
+  tocContent = '<!-- toc - begin -->\n' + '- Generate with ❤️\n' + tocContent;
+  tocContent = tocContent + '\n<!-- toc - end -->';
+  // console.log(tocContent);
+  // Insert to file.
+  // https://stackoverflow.com/questions/14177087/replace-a-string-in-a-file-with-nodejs
+  let newFileContent = fileContent;
+  // https://stackoverflow.com/questions/1979884/how-to-use-javascript-regex-over-multiple-lines
+  newFileContent = newFileContent.replace(/<!-- toc - begin -->[\s\S]*<!-- toc - end -->/gm, tocContent);
+  // console.log(newFileContent);
+  console.log('running...');
+  fs.writeFileSync(RMFilePath, newFileContent);
+  console.log('Generating Table of Contents is done.');
+};
+
 module.exports = {
   _resolve,
   version,
+  generateToc,
 };

package/scripts/dev.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 /* eslint-disable @typescript-eslint/no-var-requires */
 // const execa = require('execa');
-const { getGitCurrentBranch } = require('./github-helper');
+const { generateToc } = require('./build-helper');
 
 (async () => {
   // const { stdout: pushMsg = '' } = await execa('git', ['push'], { stdio: 'pipe' })
@@ -17,6 +17,7 @@ const { getGitCurrentBranch } = require('./github-helper');
   //   await execa('git', ['push', '--set-upstream', 'origin', currentBranch]);
   // }
   // console.log('pushMsg:', pushMsg);
-  const cb = await getGitCurrentBranch('fix returns value');
-  console.log('bbb', cb);
+  // const cb = await getGitCurrentBranch('fix returns value');
+  // console.log('bbb', cb);
+  generateToc();
 })();