Interface CookieOptions

Options passed down into res.cookie

Link

https://expressjs.com/en/api.html#res.cookie

interface CookieOptions {
    domain?: string;
    encode?: Object;
    expires?: Date;
    httpOnly?: boolean;
    maxAge?: number;
    partitioned?: boolean;
    path?: string;
    priority?: "high" | "low" | "medium";
    sameSite?: boolean | "none" | "strict" | "lax";
    secure?: boolean;
    signed?: boolean;
}

Properties

domain? encode? expires? httpOnly? maxAge? partitioned? path? priority? sameSite? secure? signed?

Properties

Optional domain

domain?: string

Domain name for the cookie. Defaults to the domain name of the app.

Optional encode

encode?: Object

A synchronous function used for cookie value encoding. Defaults to encodeURIComponent.

Optional expires

expires?: Date

Expiry date of the cookie in GMT. If not specified or set to 0, creates a session cookie.

Optional httpOnly

httpOnly?: boolean

Flags the cookie to be accessible only by the web server.

Optional maxAge

maxAge?: number

Convenient option for setting the expiry time relative to the current time in milliseconds.

Optional partitioned

partitioned?: boolean

Marks the cookie to use partioned storage.

Optional path

path?: string

Path for the cookie. Defaults to “/”.

Optional priority

priority?: "high" | "low" | "medium"

Value of the “Priority” Set-Cookie attribute.

Link

https://datatracker.ietf.org/doc/html/draft-west-cookie-priority-00#section-4.3

Optional sameSite

sameSite?: boolean | "none" | "strict" | "lax"

Value of the “SameSite” Set-Cookie attribute.

Link

https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-4.1.1.

Optional secure

secure?: boolean

Marks the cookie to be used with HTTPS only.

Optional signed

signed?: boolean

Indicates if the cookie should be signed.

Settings

Member Visibility

Theme

On This Page

domainencodeexpireshttpOnlymaxAgepartitionedpathprioritysameSitesecuresigned