@whitesev/utils 2.5.3 → 2.5.5

package/dist/types/src/UtilsGMCookie.d.ts

@@ -9,28 +9,28 @@ declare class UtilsGMCookie {
     get(cookieName: string): UtilsGMCookieResult | undefined;
     /**
      *  获取多组Cookie
-     * @param paramDetails 配置
+     * @param option 配置
      * @param callback 获取操作后的回调
      * + cookies object[]
      * + error string|undefined
      **/
-    list(paramDetails: Partial<UtilsGMCookieListOptions>, callback?: (data: UtilsGMCookieResult[], error?: Error) => void): void;
+    list(option: UtilsGMCookieListOptions, callback?: (data: UtilsGMCookieResult[], error?: Error) => void): void;
     /**
      *  获取多组Cookie
-     * @param paramDetails 配置
+     * @param option 配置
      **/
-    getList(paramDetails: Partial<UtilsGMCookieListOptions>): UtilsGMCookieResult[];
+    getList(option: UtilsGMCookieListOptions): UtilsGMCookieResult[];
     /**
      * 设置Cookie
-     * @param paramDetails 配置
+     * @param option 配置
      * @param callback 设置操作后的回调(成功/失败)
      */
-    set(paramDetails: Partial<UtilsGMCookieSetOptions>, callback?: (error?: Error) => void): void;
+    set(option: UtilsGMCookieSetOptions, callback?: (error?: Error) => void): void;
     /**
      * 删除Cookie
-     * @param paramDetails 配置
+     * @param option 配置
      * @param callback 删除操作后的回调(成功/失败)
      */
-    delete(paramDetails: Partial<UtilsGMCookieDeleteOptions>, callback?: (error?: Error) => void): void;
+    delete(option: UtilsGMCookieDeleteOptions, callback?: (error?: Error) => void): void;
 }
 export { UtilsGMCookie };

package/dist/types/src/types/UtilsGMCookie.d.ts

@@ -1,52 +1,90 @@
 export interface UtilsGMCookieResult {
 	/** 为 window.location.hostname */
 	domain: string;
+	/** 过期时间 */
 	expirationDate: null;
 	hostOnly: true;
 	httpOnly: false;
+	/** Cookie名 */
 	name: string;
+	/** Cookie的路径 */
 	path: "/";
+	/** Cookie是否同源策略 */
 	sameSite: "unspecified";
 	secure: true;
 	session: false;
+	/** Cookie值 */
 	value: string;
 }
 
 export interface UtilsGMCookieListOptions {
 	/** 默认为当前的url */
-	url: string;
-	/** 默认为当前的域名(window.location.hostname) */
-	domain: string;
+	url?: string;
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
+	domain?: string;
 	/** 需要检索的Cookie的名字 */
 	name: string | RegExp;
-	/** 需要检索的Cookie的路径，默认为"/" */
-	path: string;
+	/**
+	 * 需要检索的Cookie的路径
+	 * @default "/"
+	 */
+	path?: string;
 }
 
 export interface UtilsGMCookieSetOptions {
-	/** 默认为当前的url */
+	/**
+	 * 默认为当前的url
+	 */
 	url?: string;
-	/** 默认为当前的域名(window.location.hostname) */
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
 	domain?: string;
 	/** 需要检索的Cookie的名字 */
-	name?: string;
-	/** 需要检索的Cookie的路径，默认为"/" */
+	name: string;
+	/**
+	 * 需要检索的Cookie的路径
+	 * @default "/"
+	 */
 	path?: string;
-	/** 值 */
-	value?: string | number;
-	/** 确保Cookie只在通过安全协议（如HTTPS）的情况下传输 */
+	/** Cookie值 */
+	value: string | number;
+	/**
+	 * 确保Cookie只在通过安全协议（如HTTPS）的情况下传输
+	 * @default true
+	 */
 	secure?: boolean;
-	/** 是否防止JavaScript代码访问Cookie */
+	/**
+	 * 是否防止JavaScript代码访问Cookie
+	 * @default false
+	 */
 	httpOnly?: boolean;
-	/**  Cookie过期时间，默认为30天 */
+	/**
+	 * Cookie过期时间的时间戳，默认为30天
+	 * @default Math.floor(Date.now()) + 60 * 60 * 24 * 30
+	 */
 	expirationDate?: number;
 }
 
 export interface UtilsGMCookieDeleteOptions {
-	/** 默认为当前的url */
-	url: string;
 	/** 需要检索的Cookie的名字 */
 	name: string;
+	/** 默认为当前的url */
+	url?: string;
+	/**
+	 * Cookie的路径
+	 * @default "/"
+	 */
+	path?: string;
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
+	firstPartyDomain?: string;
 }
 
 export interface WindowApiOption {

package/dist/types/src/types/Vue2.d.ts

@@ -121,20 +121,32 @@ export declare interface Vue2Instance {
 		back: () => void;
 		go: (...args: any[]) => void;
 		replace: (...args: any[]) => void;
+		/** 添加路由 */
 		addRoute: (...args: any[]) => void;
 		addRoutes: (...args: any[]) => void;
 		[key: string]: any;
 	};
 	$ssrContext: any;
-
+	/** 观察者 @returns 取消观察者 */
 	$watch: (
+		/** 需要观察的属性 */
 		key: string | string[] | (() => any),
-		handler: (this: any, newVal: any, oldVal: any) => void,
+		/** 属性改变时触发的回调 */
+		handler: (
+			this: Vue2Instance,
+			/** 新值，也就是改变后的值 */
+			newVal: any,
+			/** 旧值，也就是改变前的值 */
+			oldVal: any
+		) => void,
+		/** 监听配置 */
 		options?: {
+			/** 是否立即执行handler */
 			immediate?: boolean;
+			/** 是否深度监听 */
 			deep?: boolean;
 		}
-	) => void;
+	) => Function;
 
 	[key: string]: any;
 }

package/dist/types/src/types/global.d.ts

@@ -22,3 +22,6 @@ export declare interface AnyObject {
 	[key: string]: any | AnyObject;
 	toString(): string;
 }
+export type PartialKeys<T, K extends keyof T> = {
+	[P in K]?: T[P];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whitesev/utils",
-  "version": "2.5.3",
+  "version": "2.5.5",
   "description": "一个常用的工具库",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -46,6 +46,7 @@
   "scripts": {
     "dev": "rollup --config --watch",
     "build": "rollup --config",
-    "build:all": "rollup --config"
+    "build:all": "rollup --config",
+    "build:all-new": "rollup --config"
   }
 }

package/src/Utils.ts

@@ -29,7 +29,7 @@ class Utils {
 		this.windowApi = new WindowApi(option);
 	}
 	/** 版本号 */
-	version = "2024.11.16";
+	version = "2024.12.3";
 
 	/**
 	 * 在页面中增加style元素，如果html节点存在子节点，添加子节点第一个，反之，添加到html节点的子节点最后一个

package/src/UtilsGMCookie.ts

@@ -54,27 +54,27 @@ class UtilsGMCookie {
 	}
 	/**
 	 *  获取多组Cookie
-	 * @param paramDetails 配置
+	 * @param option 配置
 	 * @param callback 获取操作后的回调
 	 * + cookies object[]
 	 * + error string|undefined
 	 **/
 	list(
-		paramDetails: Partial<UtilsGMCookieListOptions>,
+		option: UtilsGMCookieListOptions,
 		callback?: (data: UtilsGMCookieResult[], error?: Error) => void
 	) {
-		if (paramDetails == null) {
+		if (option == null) {
 			throw new Error("Utils.GMCookie.list 参数不能为空");
 		}
 		let resultData: UtilsGMCookieResult[] = [];
 		try {
-			let details: Partial<UtilsGMCookieListOptions> = {
+			let defaultOption: Required<UtilsGMCookieListOptions> = {
 				url: this.windowApi.window.location.href,
 				domain: this.windowApi.window.location.hostname,
 				name: "",
 				path: "/",
 			};
-			details = Utils.assign(details, paramDetails);
+			defaultOption = Utils.assign(defaultOption, option);
 			let cookies = this.windowApi.document.cookie.split(";");
 			cookies.forEach((item) => {
 				item = item.trim();
@@ -83,9 +83,9 @@ class UtilsGMCookie {
 				itemSplit.splice(0, 1);
 				let itemValue = decodeURIComponent(itemSplit.join(""));
 				let nameRegexp =
-					(details.name as RegExp) instanceof RegExp
-						? details.name
-						: new RegExp("^" + details.name, "g");
+					(defaultOption.name as RegExp) instanceof RegExp
+						? defaultOption.name
+						: new RegExp("^" + defaultOption.name, "g");
 				if (itemName.match(nameRegexp as RegExp)) {
 					resultData.push({
 						domain: this.windowApi.window.location.hostname,
@@ -112,22 +112,20 @@ class UtilsGMCookie {
 	}
 	/**
 	 *  获取多组Cookie
-	 * @param paramDetails 配置
+	 * @param option 配置
 	 **/
-	getList(
-		paramDetails: Partial<UtilsGMCookieListOptions>
-	): UtilsGMCookieResult[] {
-		if (paramDetails == null) {
+	getList(option: UtilsGMCookieListOptions): UtilsGMCookieResult[] {
+		if (option == null) {
 			throw new Error("Utils.GMCookie.list 参数不能为空");
 		}
 		let resultData: UtilsGMCookieResult[] = [];
-		let details: Partial<UtilsGMCookieListOptions> = {
+		let defaultOption: Required<UtilsGMCookieListOptions> = {
 			url: this.windowApi.window.location.href,
 			domain: this.windowApi.window.location.hostname,
 			name: "",
 			path: "/",
 		};
-		details = Utils.assign(details, paramDetails);
+		defaultOption = Utils.assign(defaultOption, option);
 		let cookies = this.windowApi.document.cookie.split(";");
 		cookies.forEach((item) => {
 			item = item.trim();
@@ -136,9 +134,9 @@ class UtilsGMCookie {
 			itemSplit.splice(0, 1);
 			let itemValue = decodeURIComponent(itemSplit.join(""));
 			let nameRegexp =
-				(details.name as RegExp) instanceof RegExp
-					? details.name
-					: new RegExp("^" + details.name, "g");
+				(defaultOption.name as RegExp) instanceof RegExp
+					? defaultOption.name
+					: new RegExp("^" + defaultOption.name, "g");
 			if (itemName.match(nameRegexp as RegExp)) {
 				resultData.push({
 					domain: this.windowApi.window.location.hostname,
@@ -158,15 +156,13 @@ class UtilsGMCookie {
 	}
 	/**
 	 * 设置Cookie
-	 * @param paramDetails 配置
+	 * @param option 配置
 	 * @param callback 设置操作后的回调(成功/失败)
 	 */
-	set(
-		paramDetails: Partial<UtilsGMCookieSetOptions>,
-		callback = (error?: Error) => {}
-	) {
+	set(option: UtilsGMCookieSetOptions, callback?: (error?: Error) => void) {
+		let errorInfo;
 		try {
-			let details: Partial<UtilsGMCookieSetOptions> = {
+			let defaultOption: Required<UtilsGMCookieSetOptions> = {
 				url: this.windowApi.window.location.href,
 				name: "",
 				value: "",
@@ -179,46 +175,52 @@ class UtilsGMCookie {
 				 */
 				expirationDate: Math.floor(Date.now()) + 60 * 60 * 24 * 30,
 			};
-			details = Utils.assign(details, paramDetails);
-			let life = details.expirationDate
-				? details.expirationDate
+			defaultOption = Utils.assign(defaultOption, option);
+			let life = defaultOption.expirationDate
+				? defaultOption.expirationDate
 				: Math.floor(Date.now()) + 60 * 60 * 24 * 30;
 			let cookieStr =
-				details.name +
+				defaultOption.name +
 				"=" +
-				decodeURIComponent(details.value as string) +
+				decodeURIComponent(defaultOption.value as string) +
 				";expires=" +
 				(new Date(life) as any).toGMTString() +
 				"; path=/";
 			this.windowApi.document.cookie = cookieStr;
-			callback();
 		} catch (error: any) {
-			callback(error);
+			errorInfo = error;
+		} finally {
+			if (typeof callback === "function") {
+				callback(errorInfo);
+			}
 		}
 	}
 	/**
 	 * 删除Cookie
-	 * @param paramDetails 配置
+	 * @param option 配置
 	 * @param callback 删除操作后的回调(成功/失败)
 	 */
 	delete(
-		paramDetails: Partial<UtilsGMCookieDeleteOptions>,
-		callback = (error?: Error) => {}
+		option: UtilsGMCookieDeleteOptions,
+		callback?: (error?: Error) => void
 	) {
+		let errorInfo;
 		try {
-			let details: Partial<UtilsGMCookieDeleteOptions> = {
+			let defaultOption: Required<UtilsGMCookieDeleteOptions> = {
 				url: this.windowApi.window.location.href,
 				name: "",
-				// @ts-ignore
-				firstPartyDomain: "",
+				path: "/",
+				firstPartyDomain: this.windowApi.window.location.hostname,
 			};
-			details = Utils.assign(details, paramDetails);
-			let cookieStr =
-				details.name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;";
+			defaultOption = Utils.assign(defaultOption, option);
+			let cookieStr = `${defaultOption.name}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=${defaultOption.path}; domain=${defaultOption.firstPartyDomain};`;
 			this.windowApi.document.cookie = cookieStr;
-			callback();
 		} catch (error: any) {
-			callback(error);
+			errorInfo = error;
+		} finally {
+			if (typeof callback === "function") {
+				callback(errorInfo);
+			}
 		}
 	}
 }

package/src/types/UtilsGMCookie.d.ts

@@ -1,52 +1,90 @@
 export interface UtilsGMCookieResult {
 	/** 为 window.location.hostname */
 	domain: string;
+	/** 过期时间 */
 	expirationDate: null;
 	hostOnly: true;
 	httpOnly: false;
+	/** Cookie名 */
 	name: string;
+	/** Cookie的路径 */
 	path: "/";
+	/** Cookie是否同源策略 */
 	sameSite: "unspecified";
 	secure: true;
 	session: false;
+	/** Cookie值 */
 	value: string;
 }
 
 export interface UtilsGMCookieListOptions {
 	/** 默认为当前的url */
-	url: string;
-	/** 默认为当前的域名(window.location.hostname) */
-	domain: string;
+	url?: string;
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
+	domain?: string;
 	/** 需要检索的Cookie的名字 */
 	name: string | RegExp;
-	/** 需要检索的Cookie的路径，默认为"/" */
-	path: string;
+	/**
+	 * 需要检索的Cookie的路径
+	 * @default "/"
+	 */
+	path?: string;
 }
 
 export interface UtilsGMCookieSetOptions {
-	/** 默认为当前的url */
+	/**
+	 * 默认为当前的url
+	 */
 	url?: string;
-	/** 默认为当前的域名(window.location.hostname) */
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
 	domain?: string;
 	/** 需要检索的Cookie的名字 */
-	name?: string;
-	/** 需要检索的Cookie的路径，默认为"/" */
+	name: string;
+	/**
+	 * 需要检索的Cookie的路径
+	 * @default "/"
+	 */
 	path?: string;
-	/** 值 */
-	value?: string | number;
-	/** 确保Cookie只在通过安全协议（如HTTPS）的情况下传输 */
+	/** Cookie值 */
+	value: string | number;
+	/**
+	 * 确保Cookie只在通过安全协议（如HTTPS）的情况下传输
+	 * @default true
+	 */
 	secure?: boolean;
-	/** 是否防止JavaScript代码访问Cookie */
+	/**
+	 * 是否防止JavaScript代码访问Cookie
+	 * @default false
+	 */
 	httpOnly?: boolean;
-	/**  Cookie过期时间，默认为30天 */
+	/**
+	 * Cookie过期时间的时间戳，默认为30天
+	 * @default Math.floor(Date.now()) + 60 * 60 * 24 * 30
+	 */
 	expirationDate?: number;
 }
 
 export interface UtilsGMCookieDeleteOptions {
-	/** 默认为当前的url */
-	url: string;
 	/** 需要检索的Cookie的名字 */
 	name: string;
+	/** 默认为当前的url */
+	url?: string;
+	/**
+	 * Cookie的路径
+	 * @default "/"
+	 */
+	path?: string;
+	/**
+	 * Cookie所在域
+	 * @default window.location.hostname
+	 */
+	firstPartyDomain?: string;
 }
 
 export interface WindowApiOption {

package/src/types/Vue2.d.ts

@@ -121,20 +121,32 @@ export declare interface Vue2Instance {
 		back: () => void;
 		go: (...args: any[]) => void;
 		replace: (...args: any[]) => void;
+		/** 添加路由 */
 		addRoute: (...args: any[]) => void;
 		addRoutes: (...args: any[]) => void;
 		[key: string]: any;
 	};
 	$ssrContext: any;
-
+	/** 观察者 @returns 取消观察者 */
 	$watch: (
+		/** 需要观察的属性 */
 		key: string | string[] | (() => any),
-		handler: (this: any, newVal: any, oldVal: any) => void,
+		/** 属性改变时触发的回调 */
+		handler: (
+			this: Vue2Instance,
+			/** 新值，也就是改变后的值 */
+			newVal: any,
+			/** 旧值，也就是改变前的值 */
+			oldVal: any
+		) => void,
+		/** 监听配置 */
 		options?: {
+			/** 是否立即执行handler */
 			immediate?: boolean;
+			/** 是否深度监听 */
 			deep?: boolean;
 		}
-	) => void;
+	) => Function;
 
 	[key: string]: any;
 }

package/src/types/global.d.ts

@@ -22,3 +22,6 @@ export declare interface AnyObject {
 	[key: string]: any | AnyObject;
 	toString(): string;
 }
+export type PartialKeys<T, K extends keyof T> = {
+	[P in K]?: T[P];
+};