Represents an environment that can perform renders.

This allows for simple rendering strategies where each render is completely standalong (as per the old react-render-server), or more complex rendering strategies where some amount of the rendering environment state is shared across renders.

Hierarchy

  • IRenderEnvironment

Implemented by

Methods

Methods

  • Generate a render result for the given url.

    Parameters

    • url: string

      The URL that is to be rendered. This is always relative to the host and so does not contain protocol, hostname, nor port information.

    • renderAPI: RenderAPI

      An API of utilities for assisting with the render operation.

    Returns Promise<RenderResult>

    The result of the render that is to be returned by the gateway service as the response to the render request. This includes the body of the response and the status code information.

Generated using TypeDoc