CookieStore: get() メソッド

構文

get(name)
get(options)

引数

このメソッドは、以下のいずれかが必要です。

name 省略可

Cookie の名前が入っている文字列です。

または

options 省略可

オブジェクトは以下のプロパティを含みます。

name

Cookie の名前が入っている文字列です。

url

Cookie の URL が入っている文字列です。

返値

Promise で、送信された name または options に一致する最初の Cookie を表すオブジェクトに解決されます。一致する Cookie がない場合は null になります。

一致した結果として返されるオブジェクトには、以下のプロパティが含まれています。

domain

Cookie のドメインを含む文字列です。

expires

Cookie の期限が入ったタイムスタンプで、ミリ秒単位の Unix 時刻です。

name

Cookie の名前を含む文字列です。

partitioned

論理値で、Cookie がパーティション化 Cookie であるか (true) そうでないか (false) を表します。詳しくは 個別区画化された状態を持つクッキー (CHIPS) を参照してください。

path

Cookie のパスを含む文字列です。

sameSite

SameSite 値（"strict"、"lax"、"none"）のいずれかです。

secure

論理値で、この Cookie が保護されたコンテキストでのみ使用されるか (true) またはそうではないか (false) を示します。

value

この Cookie の値が入った文字列です。

例外

SecurityError DOMException

オリジンが URL にシリアライズできない場合に発生します。

TypeError

以下の場合に発生します。

• options 引数が空オブジェクトであった。
• このメソッドがメインスレッドで呼び出され、url オプションが指定されているものの、現在のウィンドウの URL と一致していない。
• このメソッドはワーカー内で呼び出されており、url オプションが指定されていますが、その値はワーカーのオリジンと一致していない。
• 指定された name または options で表される Cookie のクエリーに失敗した。

例

Cookie を名前で取得する

この例では、名前を指定して特定の Cookie を取得する方法を示しています。

このコードはまず、CookieStore.set() を使用して "cookie1" という名前付きの Cookie を作成し、エラーがあればコンソールに記録します。 次に、get() を待機して、その Cookie に関する情報を取得します。 返されたプロミスがオブジェクトで解決された場合は、その 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();

仕様書

ブラウザーの互換性