@lynx-js/lynxtron / LynxTemplateBundle

#LynxTemplateBundle

#Constructors

#new LynxTemplateBundle()

new LynxTemplateBundle(buffer: any): LynxTemplateBundle

A pre-decoded Lynx template bundle.

This class corresponds to Lynx SDK's LynxTemplateBundle (TemplateBundle), which is the output of Lynx's pre-decode capability. You can parse a Lynx App Bundle ahead of time to obtain a TemplateBundle and then load it via LynxWindow.loadBundle(templateBundle) for faster startup.

Notes:

• A LynxTemplateBundle instance can be non-null but still invalid. Use isValid() to check and getErrorMessage() to inspect the parsing error.
• The constructor accepts either a Node.js Buffer or any ArrayBufferView containing the bundle bytes.

Parameters

Returns

LynxTemplateBundle

Defined in

apis/api/lynx-template-bundle.d.ts:20

#Methods

#getErrorMessage()

getErrorMessage(): string

Returns an error message when the TemplateBundle is invalid, otherwise an empty string.

Returns

string

Defined in

apis/api/lynx-template-bundle.d.ts:29

#isValid()

isValid(): boolean

Returns whether this TemplateBundle is valid.

Returns

boolean

Defined in

apis/api/lynx-template-bundle.d.ts:24