@types/cookie-session

property isChanged

isChanged?: boolean | undefined;

• Is true if the session has been changed during the request.

property isNew

isNew?: boolean | undefined;

• Is true if the session is new.

property isPopulated

isPopulated?: boolean | undefined;

• Determine if the session has been populated with data or is empty.

index signature

[propertyName: string]: any;

property domain

domain?: string | undefined;

• a string indicating the domain of the cookie (no default).

property expires

expires?: Date | undefined;

• a Date object indicating the cookie's expiration date (expires at the end of session by default).

property httpOnly

httpOnly?: boolean | undefined;

• a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).

property keys

keys?: string[] | import('keygrip') | undefined;

• The list of keys to use to sign & verify cookie values. Set cookies are always signed with keys[0], while the other keys are valid for verification, allowing for key rotation.

property maxAge

maxAge?: number | undefined;

• a number representing the milliseconds from Date.now() for expiry.

property name

name?: string | undefined;

• The name of the cookie to set, defaults to session.

property overwrite

overwrite?: boolean | undefined;

• a boolean indicating whether to overwrite previously set cookies of the same name (true by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.

property partitioned

partitioned?: boolean | undefined;

• a boolean indicating whether to partition the cookie in Chrome for the [CHIPS Update](https://developers.google.com/privacy-sandbox/3pcd/chips) (false by default). If this is true, Cookies from embedded sites will be partitioned and only readable from the same top level site from which it was created.

property path

path?: string | undefined;

• a string indicating the path of the cookie (/ by default).

property sameSite

sameSite?: 'strict' | 'lax' | 'none' | boolean | undefined;

• a boolean or string indicating whether the cookie is a "same site" cookie (false by default). This can be set to 'strict', 'lax', 'none', or true (which maps to 'strict').

property secret

secret?: string | undefined;

• A string which will be used as single key if keys is not provided.

property secure

secure?: boolean | undefined;

• a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).

property secureProxy

secureProxy?: boolean | undefined;

• a boolean indicating whether the cookie is only to be sent over HTTPS (use this if you handle SSL not in your node process).

property signed

signed?: boolean | undefined;

• a boolean indicating whether the cookie is to be signed (true by default). If this is true, another cookie of the same name with the .sig suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.

property session

session?: CookieSessionObject | null | undefined;

• Represents the session for the given request.

property sessionOptions

sessionOptions: CookieSessionOptions;

• Represents the session options for the current request. These options are a shallow clone of what was provided at middleware construction and can be altered to change cookie setting behavior on a per-request basis.