CookieSerializeOptions
Additional serialization options
§Properties
Specifies the value for the Domain Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.
Specifies the Date
object to be the value for the Expires
Set-Cookie
attribute. By default,
no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
it on a condition like exiting a web browser application.
Note the cookie storage model specification
states that if both expires
and maxAge
are set, then maxAge
takes precedence, but it is
possible not all clients by obey this, so if both are set, they should
point to the same date and time.
Specifies the boolean value for the HttpOnly
Set-Cookie
attribute.
When truthy, the HttpOnly
attribute is set, otherwise it is not. By
default, the HttpOnly
attribute is not set.
Note be careful when setting this to true, as compliant clients will
not allow client-side JavaScript to see the cookie in document.cookie
.
Specifies the number (in seconds) to be the value for the Max-Age
Set-Cookie
attribute. The given number will be converted to an integer
by rounding down. By default, no maximum age is set.
Note the cookie storage model specification
states that if both expires
and maxAge
are set, then maxAge
takes precedence, but it is
possible not all clients by obey this, so if both are set, they should
point to the same date and time.
Specifies the value for the Path
Set-Cookie
attribute.
By default, the path is considered the "default path".
Specifies the string
to be the value for the [Priority
Set-Cookie
attribute][rfc-west-cookie-priority-00-4.1].
'low'
will set thePriority
attribute toLow
.'medium'
will set thePriority
attribute toMedium
, the default priority when not set.'high'
will set thePriority
attribute toHigh
.
More information about the different priority levels can be found in [the specification][rfc-west-cookie-priority-00-4.1].
note This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
Specifies the boolean or string to be the value for the SameSite
Set-Cookie
attribute.
true
will set theSameSite
attribute toStrict
for strict same site enforcement.false
will not set theSameSite
attribute.'lax'
will set theSameSite
attribute to Lax for lax same site enforcement.'strict'
will set theSameSite
attribute to Strict for strict same site enforcement.'none'
will set the SameSite attribute to None for an explicit cross-site cookie.
More information about the different enforcement levels can be found in the specification.
note This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
Specifies the boolean value for the Secure
Set-Cookie
attribute. When truthy, the
Secure
attribute is set, otherwise it is not. By default, the Secure
attribute is not set.
Note be careful when setting this to true
, as compliant clients will
not send the cookie back to the server in the future if the browser does
not have an HTTPS connection.
§Methods
Specifies a function that will be used to encode a cookie's value. Since value of a cookie has a limited character set (and must be a simple string), this function can be used to encode a value into a string suited for a cookie's value.
The default function is the global encodeURIComponent
, which will
encode a JavaScript string into UTF-8 byte sequences and then URL-encode
any that fall outside of the cookie range.