Skip to main content
Version: 22.3.0

CookieParam interface

Cookie parameter object


export interface CookieParam


domainoptionalstringCookie domain.
expiresoptionalnumberCookie expiration date, session cookie if not set
httpOnlyoptionalbooleanTrue if cookie is http-only.
namestringCookie name.
partitionKeyoptionalstringCookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. If not set, the cookie will be set as not partitioned.
pathoptionalstringCookie path.
priorityoptionalCookiePriorityCookie Priority. Supported only in Chrome.
samePartyoptionalbooleanTrue if cookie is SameParty. Supported only in Chrome.
sameSiteoptionalCookieSameSiteCookie SameSite type.
secureoptionalbooleanTrue if cookie is secure.
sourceSchemeoptionalCookieSourceSchemeCookie source scheme type. Supported only in Chrome.
urloptionalstringThe request-URI to associate with the setting of the cookie. This value can affect the default domain, path, and source scheme values of the created cookie.
valuestringCookie value.