From c3032338fb8e3fb5d610e91bc91aac8ba605ede1 Mon Sep 17 00:00:00 2001 From: Will Harney <62956339+wjhsf@users.noreply.github.com> Date: Thu, 14 Mar 2024 11:05:13 -0400 Subject: [PATCH] Update lib/cookie/cookie.ts Co-authored-by: Colin Casey --- lib/cookie/cookie.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/cookie/cookie.ts b/lib/cookie/cookie.ts index 05d7c483..4f3af3dd 100644 --- a/lib/cookie/cookie.ts +++ b/lib/cookie/cookie.ts @@ -114,7 +114,8 @@ type ParseCookieOptions = { /** * Parses a string into a Cookie object. - * @param str Cookie string to parse + * @param str the Set-Cookie header or a Cookie string to parse. Note: when parsing a Cookie header it must be split by ';' before each Cookie string can be parsed. + * @param options configures strict or loose mode for cookie parsing * @returns `Cookie` object for valid string inputs, `undefined` for invalid string inputs, * or `null` for non-string inputs or empty string */