Skip to content

ResultRenderer

Defined in: jsEngine/engine/ResultRenderer.ts:14

Attaches to a container and renders values. Used to render the result of a JsExecution.

Constructors

new ResultRenderer()

new ResultRenderer(plugin, container, sourcePath, component): ResultRenderer

Defined in: jsEngine/engine/ResultRenderer.ts:20

Parameters

Parameter Type

plugin

JsEnginePlugin

container

HTMLElement

sourcePath

string

component

Component

Returns

ResultRenderer

Properties

component

readonly component: Component

Defined in: jsEngine/engine/ResultRenderer.ts:18


container

readonly container: HTMLElement

Defined in: jsEngine/engine/ResultRenderer.ts:16


plugin

readonly plugin: JsEnginePlugin

Defined in: jsEngine/engine/ResultRenderer.ts:15


sourcePath

readonly sourcePath: string

Defined in: jsEngine/engine/ResultRenderer.ts:17

Methods

convertToSimpleObject()

convertToSimpleObject(value): unknown

Defined in: jsEngine/engine/ResultRenderer.ts:92

Converts the given value to a simple object. E.g. a MarkdownBuilder will be converted to a string.

Parameters

Parameter Type Description

value

unknown

The value to convert.

Returns

unknown

The simple object.


render()

render(value): Promise<void>

Defined in: jsEngine/engine/ResultRenderer.ts:32

Renders the given value to the container.

Parameters

Parameter Type Description

value

unknown

The value to render.

Returns

Promise<void>