Home > resol-vbus-core-script

resol-vbus-core-script package

Accessory library for providing scripting functionality and interfaces.

This library is part of the resol-vbus-core ecosystem.

• [Documentation](https://resol-vbus-core.bugstu.be/) - [Code](https://codeberg.org/DanielWippermann/resol-vbus-core)

Functions

Function	Description
parseScript(scriptContents, filename)	Parse the provided script contents into a function.

Interfaces

Interface	Description
CreateDatagramOptions	Options passed to ScriptDollar.createDatagram().
CreatePacketOptions	Options passed to ScriptDollar.createPacket().
CreateTelegramOptions	Options passed to ScriptDollar.createTelegram().
IdleEvent	The event passed to callbacks registered with ScriptDollar.onIdle().
JunkDataEvent	The event passed to callbacks registered with ScriptDollar.onJunkData().
ParsedScript	The result of parseScript().
RawDataEvent	The event passed to callbacks registered with ScriptDollar.onRawData().
ScriptDollar	The type of the $ argument passed to the defineScript handler.
ScriptInterface	The result of the parsed script.

Type Aliases

Type Alias	Description
DefineScriptFunction	The type of the defineScript function inside the parsed script.
DefineScriptHandler	The argument passed to defineScript.
RequireScriptFunction	The type of the require function inside the parsed script.
ScriptExports	The value of module inside the parsed script.
ScriptFunction	The script function produced by parseScript().
ScriptModule	The value of exports inside the parsed script.