CookieStore.set()
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
CookieStore
インターフェイスの getAll()
メソッドは、渡された名前またはオプションに一致する Cookie のリストを返します。引数を何も渡さなければ、現在のコンテキストのすべての Cookie を返します。
構文
var promise = cookieStore.set(name,value);
var promise = cookieStore.set(options);
引数
このメソッドは、以下のいずれかが必要です。
name
-
Cookie の名前が入っている
USVString
です。 value
-
Cookie の値が入っている
USVString
です。 - オプション
-
オブジェクトは次のものを含みます。
name
-
Cookie の名前が入っている
USVString
です。 value
-
Cookie の値が入っている
USVString
です。 expires
省略可-
Cookie の有効期限を含む
DOMTimeStamp
です。 domain
省略可-
Cookie のドメインを含む
USVString
です。 path
省略可-
Cookie のパスを含む
USVString
です。 sameSite
省略可-
以下の SameSite のいずれかの値です。
"strict"
-
Cookie は、ファーストパーティのコンテキストでのみ送信され、サードパーティのウェブサイトによるリクエストと一緒に送信されることはありません
"lax"
-
Cookie は、通常のクロスサイト・サブクエスト(例えば、画像やフレームをサードパーティのサイトにロードするため)には送信されません。しかし、ユーザーが元のサイト内を移動しているとき(すなわち、リンクをたどっているとき)には送信されます。
"none"
-
Cookie は、すべてのコンテキストで送信されます。
メモ: SameSite cookies の詳細については、 SameSite cookies explained をご覧ください。
返値
例外
TypeError
-
与えられた値での Cookie の設定に失敗した場合にスローされます。
DOMException
SecurityError
-
オリジンが URL に serialize (en-US) されない場合にスローされます。
例
次の例では name
、value
、expires
、domain
を持つオブジェクトを渡して Cookie を設定します。
const day = 24 * 60 * 60 * 1000;
cookieStore.set({
name: "cookie1",
value: "cookie1-value",
expires: Date.now() + day,
domain: "example.com"
});
仕様書
Specification |
---|
Cookie Store API # dom-cookiestore-set |
ブラウザーの互換性
BCD tables only load in the browser