Skip to main content

ServerSsrContext

import { ServerSsrContext } from '@dr.pogodin/react-utils';

The ServerSsrContext class extends SsrContext class from the React Global State library; it is used by React Utils server() factory as a part of SSR setup.

Generic Parameters​

  • StateT — The type of global state object.

Properties​

  • chunkGroups — ChunkGroupsT

  • chunks — string[] — Defaults empty array.

  • redirectTo — readonly string | undefined — Undefined by default; if it is set by the app during SSR, the server will trigger redirect to this URL, instead of serving the generated HTML markup. Note, it will use status property (below) to set the redirect code, thus it also should be set to appropriate code to perform a redirect.

  • req — Request — ExpressJS request being handled.

  • status — readonly number — HTTP status for the response. Defaults 200 (OK).

Methods​

constructor()​

constructor(req: Request, chunkGroups: ChunkGroupsT, initialState?: StateT)

Creates a new ServerSsrContext instance.

Arguments

  • res — Request
  • chunkGroups — ChunkGroupsT
  • initialState — StateT — Optional. Initial global state value.

setStatus()​

.setStatus(status: number, redirectTo?: string): void;

Sets values of readonly redirectTo and status properties (they are readonly as react-hooks/immutability disallows direct assignment of properties on objects returned from hooks).