Skip to main content

Interface: ReportRenderer<TOutput, TOptions>

Defined in: packages/core/src/report/render.ts:23

Type Parameters​

TOutput​

TOutput extends ReportRenderBody | Promise<ReportRenderBody> = ReportRenderBody | Promise<ReportRenderBody>

TOptions​

TOptions extends object = Record<string, never>

Properties​

disposition​

readonly disposition: "inline" | "attachment"

Defined in: packages/core/src/report/render.ts:32

attachment: serve the body as a download named <name>.<fileExtension>. inline: show it in place.


fileExtension​

readonly fileExtension: string

Defined in: packages/core/src/report/render.ts:33


format​

readonly format: string

Defined in: packages/core/src/report/render.ts:28

Stable format name. Hosts select renderers by this value.


mediaType​

readonly mediaType: string

Defined in: packages/core/src/report/render.ts:30

The response content type.

Methods​

render()​

render(data, options?): TOutput

Defined in: packages/core/src/report/render.ts:35

Returns the response body, or a Promise of it. Renderers expect valid data: parse stored JSON with parseReportData first.

Parameters​

data​

ReportData

options?​

TOptions

Returns​

TOutput