Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Script

Script class

Hierarchy

  • Script

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • new Script(functionBody: string, name: string, path: string): Script
  • Create a script instance

    Parameters

    • functionBody: string

      the function source

    • name: string

      name of the script

    • path: string

      path of the script

    Returns Script

Properties

dir

dir: string

fn

fn: Function

name

name: string

name of the script

path

path: string

path of the script

type

type: "Script" = "Script"

Methods

run

  • run(stage: Stage): Promise<unknown>
  • Execute the script

    Parameters

    • stage: Stage

      the stage context

    Returns Promise<unknown>

    • resolve when script finished running

Object literals

signals

signals: object

elementAdded

elementAdded: Signal<T> = new Signal()

elementRemoved

elementRemoved: Signal<T> = new Signal()

nameChanged

nameChanged: Signal<T> = new Signal()

Generated using TypeDoc