Skip to content

@maxhealth.tech/prefab / renderer / PrefabRenderer

Variable: PrefabRenderer

ts
const PrefabRenderer: object;

Defined in: renderer/index.ts:123

Type Declaration

mount()

ts
mount(
   root, 
   initialData, 
   options?): MountedApp;

Mount a prefab UI into a DOM element.

Parameters

ParameterTypeDescription
rootHTMLElementThe DOM element to render into.
initialDataPrefabWireData-
options?MountOptionsOptional transport and toast handler.

Returns

MountedApp

A MountedApp handle for updates and cleanup.

isPrefabData()

ts
isPrefabData(data): data is PrefabWireData;

Check if data is a prefab wire format.

Parameters

ParameterType
dataunknown

Returns

data is PrefabWireData

isPrefabUpdate()

ts
isPrefabUpdate(data): data is PrefabUpdateData;

Check if data is a prefab state update.

Parameters

ParameterType
dataunknown

Returns

data is PrefabUpdateData

Released under the MIT License.