mazey 4.10.0 → 4.10.2

package/lib/perf.d.ts

@@ -1,213 +0,0 @@
-import type { WebPerformance } from "./typing";
-/**
- * @hidden
- */
-export 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
- */
-export declare function getFCP(): Promise<number>;
-/**
- * Gets the first paint (FP) time of a web page using the Performance API.
- * The FP time is the time it takes for the first pixel to be painted on the screen.
- *
- * Usage:
- *
- * ```javascript
- * 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
- */
-export declare function getFP(): Promise<number>;
-/**
- * Gets the largest contentful paint (LCP) time of a web page using the Performance API.
- * The LCP time is the time it takes for the largest piece of content to be painted on the screen.
- *
- * Usage:
- *
- * ```javascript
- * 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
- */
-export declare function getLCP(): Promise<number>;
-/**
- * Gets the first input delay (FID) of a web page using the Performance API.
- * The FID is the time it takes for the first user input to be processed by the browser.
- *
- * Usage:
- *
- * ```javascript
- * 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
- */
-export declare function getFID(): Promise<number>;
-/**
- * Gets the Cumulative Layout Shift (CLS) score of a web page using the Performance API.
- * The CLS score is a measure of how much the page layout shifts during loading.
- *
- * Usage:
- *
- * ```javascript
- * 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
- */
-export declare function getCLS(): Promise<number>;
-/**
- * Gets the time to first byte (TTFB) of a web page using the Performance API.
- * The TTFB is the time it takes for the first byte of the response to be received by the browser.
- *
- * Usage:
- *
- * ```javascript
- * 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
- */
-export declare function getTTFB(): Promise<number>;
-/**
- * EN: Get page load time(`PerformanceNavigationTiming`).
- *
- * ZH: 获取页面加载相关的各项数据。
- *
- * @remarks
- * This function uses the [`PerformanceNavigationTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming) API to get page load time data.
- * The `PerformanceNavigationTiming` API provides more accurate and detailed information about page load time than the deprecated [`PerformanceTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming) API.
- * If you are using an older browser that does not support `PerformanceNavigationTiming`, you can still use the `PerformanceTiming` API by using the previous version of this library ([`v3.9.7`](https://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
- */
-export declare function getPerformance(camelCase?: boolean): Promise<WebPerformance | Error>;
-//# sourceMappingURL=perf.d.ts.map

package/lib/perf.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"perf.d.ts","sourceRoot":"","sources":["../src/perf.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,WAUhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAe9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAe7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAe9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAoB9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAmB9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAc/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAsB,cAAc,CAAC,SAAS,UAAQ,GAAG,OAAO,CAAC,cAAc,GAAG,KAAK,CAAC,CA8QvF"}

package/lib/store.d.ts

@@ -1,230 +0,0 @@
-/**
- * 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
- */
-export declare function setSessionStorage<T>(key: string, value?: T | null): void;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage。
- *
- * 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
- */
-export 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
- */
-export declare function setLocalStorage<T>(key: string, value?: T | null): void;
-/**
- * EN: Handle Storage (Keep fit for JSON, it can transfer format automatically).
- *
- * ZH: 存储/获取数据到 sessionStorage/localStorage。
- *
- * 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
- */
-export 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
- */
-export 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
- */
-export 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
- */
-export declare function removeCookie(name: string): boolean;
-/**
- * Alias of `removeCookie`.
- *
- * @hidden
- */
-export declare function delCookie(name: string): void;
-//# sourceMappingURL=store.d.ts.map

package/lib/store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,CAAC,GAAG,IAAW,GAAG,IAAI,CAI9E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,CAS1D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,CAAC,GAAG,IAAW,GAAG,IAAI,CAI5E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,CASxD;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAmC3F;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAclD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAE5C"}