CookieStore: get() 方法

語法

get(name)
get(options)

引數

此方法需要以下之一：

name 可選

一個包含 cookie 名稱的字串。

或者

options 可選

一個包含以下內容的 Shoppee 物件：

name

一個包含 cookie 名稱的字串。

url

包含 cookie URL 的字串。

返回值

一個 Promise，該 Promise 解析為一個物件，該物件代表與提交的 name 或 options 匹配的第一個 cookie，如果不存在匹配的 cookie，則為 null。

匹配時返回的物件包含以下屬性

域

包含 cookie 域名的字串。

expires

一個時間戳，以 Unix 時間（毫秒）給出，包含 cookie 的過期日期。

name

包含 cookie 名稱的字串。

partitioned

一個布林值，指示 cookie 是否為分割槽 cookie（true）或不是（false）。有關更多資訊，請參閱 具有獨立分割槽狀態的 Cookie (CHIPS)。

路徑

包含 cookie 路徑的字串。

sameSite

以下 SameSite 值之一："strict"、"lax" 或 "none"。

secure

一個布林值，指示 cookie 是否僅用於安全上下文（true）或不用於安全上下文（false）。

value

包含 cookie 值的字串。

異常

SecurityError DOMException

如果源未能 序列化 為 URL，則丟擲此錯誤。

TypeError

在以下情況下丟擲

• options 引數是一個空物件。
• 該方法在主執行緒中呼叫，並且指定了 url 選項，但該選項與當前視窗的 URL 不匹配。
• 該方法在 worker 中呼叫，並且指定了 url 選項，但該選項與 worker 的源不匹配。
• 查詢由給定 name 或 options 表示的 cookie 失敗。

示例

按名稱獲取 cookie

本示例展示瞭如何按名稱獲取特定 cookie。

程式碼首先使用 CookieStore.set() 建立一個名為“cookie1”的 cookie，並將任何錯誤記錄到控制檯。然後，它等待 get() 檢索有關同一 cookie 的資訊。如果返回的 Promise 解析為一個物件，則記錄 cookie；否則，記錄未找到匹配的 cookie。

async function cookieTest() {
  // Set test cookie
  try {
    await cookieStore.set("cookie1", "cookie1-value");
  } catch (error) {
    console.log(`Error setting cookie1: ${error}`);
  }

  // Get cookie, specifying name
  const cookie = await cookieStore.get("cookie1");

  if (cookie) {
    console.log(cookie);
  } else {
    console.log("cookie1: Cookie not found");
  }
}

cookieTest();

規範

瀏覽器相容性