Interface NextReduxCookieMiddlewareConfig

The configuration options for nextReduxCookieMiddleware. The subtrees option specifies which subtrees of the state shall be synced with cookies, and how. It takes a list of state subtree paths (e.g. my.subtree) or SubtreeConfig objects. All SubtreeConfig options (except subtree and cookieName) can also be set globally, making them the default for all subtrees.

Example

{
  secure: true,
  subtrees: [
    "my.first.subtree",
    {subtree: "subtree.two"},
    {subtree: "three", secure: false},
  ]
}

would set the secure option to true for the cookies of my.first.subtree and subtree.two, but false for three.

Hierarchy

  • Omit<SubtreeConfig, "subtree" | "cookieName" | "defaultState">
    • NextReduxCookieMiddlewareConfig

Properties

compress deserializationFunction domain expires ignoreStateFromStaticProps maxAge path sameSite secure serializationFunction subtrees

Properties

Optional compress

compress?: boolean

Whether or not to compress cookie values using lz-string. Defaults to true if serializationFunction and deserializationFunction have not been specified, and false otherwise.

Optional deserializationFunction

deserializationFunction?: ((state: string) => unknown)

Type declaration

    • (state: string): unknown

    • A function that parses a string created by serializationFunction and returns the corresponding subtree state. Defaults to JSON.parse.

      Parameters

      • state: string

      Returns unknown

Optional domain

domain?: 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.

Optional expires

expires?: 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.

Optional ignoreStateFromStaticProps

ignoreStateFromStaticProps?: boolean

Whether or not to ignore a subtree's state in a state update from getStaticProps() (defaults to true). If false, the state from getStaticProps() will be contained in the HYDRATE action without any changes, leaving the merging up to the HYDRATE reducer. If true, the received state from getStaticProps() will be replaced with the current client state before the HYDRATE action is dispatched. This prevents the client's state from being reset to the state from getStaticProps().

Optional maxAge

maxAge?: 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.

Optional path

path?: string

Specifies the value for the Set-Cookie attribute. By default, the path is considered the "default path".

Optional sameSite

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

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.

Optional secure

secure?: 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.

Optional serializationFunction

serializationFunction?: ((state: unknown) => string)

Type declaration

    • (state: unknown): string

    • A function that serializes subtree state into a string. Defaults to JSON.stringify.

      Note

      If you set this, make sure to also set the deserializationFunction option accordingly.

      Parameters

      • state: unknown

      Returns string

subtrees

subtrees: (string | SubtreeConfig)[]

Specifies which subtrees of the state shall be synced with cookies, and how. Takes a list of subtree paths (e.g. my.subtree) and/or SubtreeConfig objects.

Settings

Member Visibility

Theme

Generated using TypeDoc