@whitesev/utils 1.3.3 → 1.3.5

package/dist/src/UtilsGMCookie.d.ts

@@ -21,6 +21,30 @@ declare interface UtilsGMCookieListOptions {
     /** 需要检索的Cookie的路径，默认为"/" */
     path: string;
 }
+declare interface UtilsGMCookieSetOptions {
+    /** 默认为当前的url */
+    url?: string;
+    /** 默认为当前的域名(window.location.hostname) */
+    domain?: string;
+    /** 需要检索的Cookie的名字 */
+    name?: string;
+    /** 需要检索的Cookie的路径，默认为"/" */
+    path?: string;
+    /** 值 */
+    value?: string | number;
+    /** 确保Cookie只在通过安全协议（如HTTPS）的情况下传输 */
+    secure?: boolean;
+    /** 是否防止JavaScript代码访问Cookie */
+    httpOnly?: boolean;
+    /**  Cookie过期时间，默认为30天 */
+    expirationDate?: number;
+}
+declare interface UtilsGMCookieDeleteOptions {
+    /** 默认为当前的url */
+    url: string;
+    /** 需要检索的Cookie的名字 */
+    name: string;
+}
 declare class UtilsGMCookie {
     /**
      * 获取单个cookie
@@ -29,28 +53,28 @@ declare class UtilsGMCookie {
     get(cookieName: string): UtilsGMCookieResult | undefined;
     /**
      *  获取多组Cookie
-     * @param paramDetails
-     * @param callback
+     * @param paramDetails 配置
+     * @param callback 获取操作后的回调
      * + cookies object[]
      * + error string|undefined
      **/
     list(paramDetails: Partial<UtilsGMCookieListOptions>, callback?: (data: UtilsGMCookieResult[], error?: Error) => void): void;
     /**
      *  获取多组Cookie
-     * @param paramDetails
+     * @param paramDetails 配置
      **/
     getList(paramDetails: Partial<UtilsGMCookieListOptions>): UtilsGMCookieResult[];
     /**
      * 设置Cookie
-     * @param paramDetails
-     * @param callback
+     * @param paramDetails 配置
+     * @param callback 设置操作后的回调(成功/失败)
      */
-    set(paramDetails?: {}, callback?: (error?: Error) => void): void;
+    set(paramDetails: Partial<UtilsGMCookieSetOptions>, callback?: (error?: Error) => void): void;
     /**
      * 删除Cookie
-     * @param paramDetails
-     * @param callback
+     * @param paramDetails 配置
+     * @param callback 删除操作后的回调(成功/失败)
      */
-    delete(paramDetails?: {}, callback?: (error?: Error) => void): void;
+    delete(paramDetails: Partial<UtilsGMCookieDeleteOptions>, callback?: (error?: Error) => void): void;
 }
 export { UtilsGMCookie };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@whitesev/utils",
-	"version": "1.3.3",
+	"version": "1.3.5",
 	"description": "一个常用的工具库",
 	"main": "dist/index.cjs.js",
 	"module": "dist/node/index.esm.js",

package/src/UtilsGMCookie.ts

@@ -36,9 +36,9 @@ declare interface UtilsGMCookieSetOptions {
 	path?: string;
 	/** 值 */
 	value?: string | number;
-	/**  */
+	/** 确保Cookie只在通过安全协议（如HTTPS）的情况下传输 */
 	secure?: boolean;
-	/**  */
+	/** 是否防止JavaScript代码访问Cookie */
 	httpOnly?: boolean;
 	/**  Cookie过期时间，默认为30天 */
 	expirationDate?: number;
@@ -89,8 +89,8 @@ class UtilsGMCookie {
 	}
 	/**
 	 *  获取多组Cookie
-	 * @param paramDetails
-	 * @param callback
+	 * @param paramDetails 配置
+	 * @param callback 获取操作后的回调
 	 * + cookies object[]
 	 * + error string|undefined
 	 **/
@@ -147,7 +147,7 @@ class UtilsGMCookie {
 	}
 	/**
 	 *  获取多组Cookie
-	 * @param paramDetails
+	 * @param paramDetails 配置
 	 **/
 	getList(
 		paramDetails: Partial<UtilsGMCookieListOptions>
@@ -193,10 +193,13 @@ class UtilsGMCookie {
 	}
 	/**
 	 * 设置Cookie
-	 * @param paramDetails
-	 * @param callback
+	 * @param paramDetails 配置
+	 * @param callback 设置操作后的回调(成功/失败)
 	 */
-	set(paramDetails = {}, callback = (error?: Error) => {}) {
+	set(
+		paramDetails: Partial<UtilsGMCookieSetOptions>,
+		callback = (error?: Error) => {}
+	) {
 		try {
 			let details: Partial<UtilsGMCookieSetOptions> = {
 				url: window.location.href,
@@ -224,16 +227,19 @@ class UtilsGMCookie {
 				"; path=/";
 			document.cookie = cookieStr;
 			callback();
-		} catch (error) {
-			callback(error as Error);
+		} catch (error: any) {
+			callback(error);
 		}
 	}
 	/**
 	 * 删除Cookie
-	 * @param paramDetails
-	 * @param callback
+	 * @param paramDetails 配置
+	 * @param callback 删除操作后的回调(成功/失败)
 	 */
-	delete(paramDetails = {}, callback = (error?: Error) => {}) {
+	delete(
+		paramDetails: Partial<UtilsGMCookieDeleteOptions>,
+		callback = (error?: Error) => {}
+	) {
 		try {
 			let details: Partial<UtilsGMCookieDeleteOptions> = {
 				url: window.location.href,
@@ -246,8 +252,8 @@ class UtilsGMCookie {
 				details.name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;";
 			document.cookie = cookieStr;
 			callback();
-		} catch (error) {
-			callback(error as Error);
+		} catch (error: any) {
+			callback(error);
 		}
 	}
 }