CookieStore: get() メソッド

構文

get(name)
get(options)

引数

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

name

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

または

options

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

name

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

url

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

返値

与えられた名前またはオプションに一致する最初の Cookie を含むオブジェクトに解決される Promise です。このオブジェクトは以下のプロパティを含んでいます。

domain

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

expires

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

name

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

partitioned

論理値で、Cookie がパーティション化 Cookie であるか (true) そうでないか (false) を表します。詳しくは Cookies Having Independent Partitioned State (CHIPS) を参照してください。

path

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

sameSite

以下の SameSite 値のうちの何れかです。

"strict"

Cookie はファーストパーティのコンテキストにのみ送られ、サードパーティのウェブサイトに対するリクエストには送られません。

"lax"

Cookie は、通常のサイト間サブリクエスト（例えば、サードパーティーのサイトに画像やフレームを読み込むためのもの）には送信されませんが、ユーザーがオリジン間サイト内を移動しているとき（リンクを追跡するとき）には送信されます。

"none"

Cookie はすべてのコンテキストで、送信されます。

secure

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

value

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

例外

TypeError

与えられた name や options で表される Cookie の取得に失敗した場合に発生します。

例

この例では、"cookie1" という名前の Cookie を返します。もし Cookie が見つかれば、プロミスの結果は 1 つの Cookie の詳細を含むオブジェクトになります。

let cookie = cookieStore.get("cookie1");
if (cookie) {
  console.log(cookie);
} else {
  console.log("Cookie not found");
}

仕様書

ブラウザーの互換性