Class SubAppServerRenderPipeline

The server side rendering pipeline for a subapp

The pipeline involves preparing the data (which is async), and then rendering the component to string or stream, which can be sync or async.

It's also possible that the subapp only wants the data but not actually rendering the component.

  • load will setup this and kick off prepare data
  • start will await for prepare data and render, and inject result into HTML

Implements

Constructors

constructor

Properties

_mount _reload _unmount framework? options outputSpot? prepResult? preparePromise? ssrData? startTime? INITIAL_STATE_TAG_ID

Methods

executeRender getPrepResult isPrepared start startPrepare waitForPrepare

Constructors

constructor

Properties

_mount

_mount: ((info) => void)

For HMR: a component mount itself to the subapp/pipeline - empty filler

Type declaration

_reload

_reload: (() => Promise<any>)

Hot module reload (HMR) support - empty filler

Type declaration

    • (): Promise<any>

    • Returns Promise<any>

_unmount

_unmount: ((info) => void)

For HMR: a component unmount itself from the subapp/pipeline - empty filler

Type declaration

Optional framework

framework?: ServerFrameworkLib

options

options: LoadSubAppOptions

options for rendering the subapp into HTML page

Optional outputSpot

outputSpot?: any

spot in HTML output to inject the result from SSR

Optional prepResult

prepResult?: SubAppFeatureResult

data from prepareData

Optional preparePromise

preparePromise?: Promise<unknown>

the promise for subapp's data prepare

Optional ssrData

ssrData?: SubAppSSRData

Optional startTime

startTime?: number

Static INITIAL_STATE_TAG_ID

INITIAL_STATE_TAG_ID: number = 0

Methods

executeRender

getPrepResult

isPrepared

start

startPrepare

waitForPrepare

Settings

Member Visibility

Theme

On This Page

constructor_mount_reload_unmountframeworkoptionsoutputSpotprepResultpreparePromisessrDatastartTimeINITIAL_STATE_TAG_IDexecuteRendergetPrepResultisPreparedstartstartPreparewaitForPrepare