resources/src/mediawiki.cookie/types.js

   1 /**
   2  * @typedef {Object} module:mediawiki.cookie~CookieOptions Custom scope for cookie key, must match the way it was set.
   3  * @property {string} [path] The path attribute of the cookie. Defaults to wgCookiePath.
   4  * @property {string} [prefix] The prefix of the key. Defaults to wgCookiePrefix.
   5  * @property {string} [domain] Custom scope for cookie key. The domain attribute of the cookie.
   6  *  Defaults to wgCookieDomain.
   7  * @property {boolean} [secure] Whether or not to include the secure attribute. Defaults to false.
   8  *   (Does **not** use the wgCookieSecure configuration variable)
   9  * @property {string} [sameSite] The SameSite flag of the cookie ('None' / 'Lax'
  10  *   / 'Strict', case-insensitive; default is to omit the flag, which results in Lax on
  11  *   modern browsers). Set to None AND set secure=true if the cookie needs to be visible on
  12  *   cross-domain requests.
  13  * @property {boolean} [sameSiteLegacy] Deprecated, ignored.
  14  * @property {Date|number|null} [expires] Number of days to store the value (when setting).
  15  *  The expiry date of the cookie, or lifetime in seconds.
  16  *  If null or 0, then a session cookie is set. Defaults to wgCookieExpiration.
  17  */