Class Environment

A render environment built to support the JSDOM 16.x API.

Hierarchy

Environment

Implements

IRenderEnvironment

Index

Constructors

Properties

_configuration _retrieveTargetFiles render

Methods

_closeAll _runScript

Constructors

constructor

new Environment(configuration): Environment
Create a new instance of this environment.
Parameters
- configuration: IJSDOMConfiguration
  Configuration for the environment.
Returns Environment
- Defined in packages/wonder-stuff-render-environment-jsdom/src/jsdom-environment.ts:59

Properties

_configuration

_configuration: IJSDOMConfiguration

_retrieveTargetFiles

_retrieveTargetFiles: ((url, renderAPI, resourceLoader) => Promise<JavaScriptFiles>) = ...

Type declaration

- (url, renderAPI, resourceLoader): Promise<JavaScriptFiles>
- Parameters
  - url: string
  - renderAPI: RenderAPI
  - resourceLoader: CloseableResourceLoader
  Returns Promise<JavaScriptFiles>

render

render: ((url, renderAPI) => Promise<RenderResult>) = ...

Type declaration

- (url, renderAPI): Promise<RenderResult>
- 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.

Methods

_closeAll

_closeAll(closeables, logger): Promise<void>
Parameters
- closeables: (undefined | null | ICloseable)[]
- logger: Logger
Returns Promise<void>
- Defined in packages/wonder-stuff-render-environment-jsdom/src/jsdom-environment.ts:133

_runScript

_runScript<T>(vmContext, script, options?): Promise<T>
Type Parameters
- T
Parameters
- vmContext: Context
- script: string
- Optional options: ScriptOptions
Returns Promise<T>
- Defined in packages/wonder-stuff-render-environment-jsdom/src/jsdom-environment.ts:184

Generated using TypeDoc