Additional serialization options
Type: string
Specifies the value for the Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.
Type: Date
Specifies the Date
object to be the value for the 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 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.
Type: boolean
Specifies the boolean value for the 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
.
Type: number
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 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.
Type: boolean
Specifies the boolean
value for the Partitioned
Set-Cookie
attribute. When truthy, the Partitioned
attribute is set, otherwise it is not. By default, the
Partitioned
attribute is not set.
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.
More information about can be found in the proposal
Type: string
Specifies the value for the Set-Cookie
attribute.
By default, the path is considered the "default path".
Type: "high" | "low" | "medium"
Specifies the string
to be the value for the [Priority
Set-Cookie
attribute][rfc-west-cookie-priority-00-4.1].
'low'
will set the Priority
attribute to Low
.'medium'
will set the Priority
attribute to Medium
, the default priority when not set.'high'
will set the Priority
attribute to High
.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.
Type: boolean | "none" | "strict" | "lax"
Specifies the boolean or string to be the value for the Set-Cookie
attribute.
true
will set the SameSite
attribute to Strict
for strict same
site enforcement.false
will not set the SameSite
attribute.'lax'
will set the SameSite
attribute to Lax for lax same site
enforcement.'strict'
will set the SameSite
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 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.
Type: boolean
Specifies the boolean value for the 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.
Type: encode(value): string