Represents information about an HTTP cookie.
Type
Values of this type are objects. They contain the following properties:
name
string
. The name of the cookie.value
string
. The value of the cookie.domain
string
. The domain of the cookie (e.g. "www.google.com", "example.com").hostOnly
boolean
. True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).path
string
. The path of the cookie.secure
boolean
. True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).httpOnly
boolean
. True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).session
boolean
. True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.expirationDate
Optionalnumber
. The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.storeId
string
. The ID of the cookie store containing this cookie, as provided in getAllCookieStores().
Browser compatibility
Acknowledgements
This API is based on Chromium's chrome.cookies
API. This documentation is derived from cookies.json
in the Chromium code.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.