Interface IJSDOMConfiguration

Configuration for a JSDOM environment.

Hierarchy

IJSDOMConfiguration

Implemented by

Configuration

Index

Accessors

registrationCallbackName

Methods

afterEnvSetup getFileList getResourceLoader

Accessors

registrationCallbackName

get registrationCallbackName(): string
The name of the callback function that should be exposed by the environment for renderable code to use when registering for rendering.

Returns string
- Defined in packages/wonder-stuff-render-environment-jsdom/src/types.ts:55

Methods

afterEnvSetup

afterEnvSetup(url, fileURLs, renderAPI, vmContext?): Promise<undefined | null | ICloseable>
Perform any additional environment setup.

This method gets access to the actual environment in which code will execute. Be careful what you do.
Parameters
- url: string
  The URL that is to be rendered.
- fileURLs: readonly string[]
- renderAPI: RenderAPI
  An API of utilities for assisting with the render operation.
- Optional vmContext: any
  The actual environment that is being setup.
Returns Promise<undefined | null | ICloseable>
A promise that the additional setup is done.
- Defined in packages/wonder-stuff-render-environment-jsdom/src/types.ts:100

getFileList

getFileList(url, renderAPI, fetchFn): Promise<string[]>
Get the list of file URLs to retrieve and execute for the given request.
Parameters
- url: string
  The URL that is to be rendered.
- renderAPI: RenderAPI
  An API of utilities for assisting with the render operation.
- fetchFn: ((url) => undefined | null | Promise<Buffer>)
  Function to fetch a URL. Using this ensures proper tidy-up of associated sockets and agents.
  - - (url): undefined | null | Promise<Buffer>
    - Parameters
      url: string
      Returns undefined | null | Promise<Buffer>
Returns Promise<string[]>
An ordered array of absolute URLs for the JavaScript files that are to be executed. These are exectued in the same order as the array.
- Defined in packages/wonder-stuff-render-environment-jsdom/src/types.ts:83

getResourceLoader

getResourceLoader(url, renderAPI): CloseableResourceLoader
Get a JSDOM resource loader for the given render request.
Parameters
- url: string
  The URL that is to be rendered.
- renderAPI: RenderAPI
  An API of utilities for assisting with the render operation.
Returns CloseableResourceLoader
A ResourceLoader instance for use with JSDOM that can optionally have a close() method, which will be invoked when the render completes.
- Defined in packages/wonder-stuff-render-environment-jsdom/src/types.ts:66

Generated using TypeDoc