Class JSScript

Class representing JavaScript scripts.

Hierarchy

JSScript

Implements

IScript

Index

Constructors

constructor

Properties

Methods

run

Object literals

signals

Constructors

constructor

new JSScript(functionBody: string, name: string, path: string): JSScript

- Defined in backend/src/script.ts:46
Create a script instance

Parameters
- functionBody: string
  
  the function source (can reference "stage" and "scriptingApi" variables)
- name: string
  
  name of the script
- path: string
  
  path of the script
Returns JSScript

Properties

Readonly dir

dir: string

Readonly fn

fn: Function

Readonly name

name: string

name of the script

Readonly path

path: string

path of the script

Readonly type

type: "Script" = "Script"

Methods

run

run(stage: Stage, args?: any[]): Promise<unknown>

Implementation of IScript.run
- Defined in backend/src/script.ts:66
Parameters
- stage: Stage
- Optional args: any[]
Returns Promise<unknown>

Object literals

Readonly signals

signals: object

elementAdded

elementAdded: Signal<T> = new Signal()

elementRemoved

elementRemoved: Signal<T> = new Signal()

nameChanged

nameChanged: Signal<T> = new Signal()

Generated using TypeDoc