import Scripteasy from 'scripteasy'

public class | source

Scripteasy

The main scripteasy class. It serves as an entry point into scripteasy's primary functionality.

Static Method Summary

Static Public Methods
public static	fromFile(filename: string): Scripteasy Reads scripts from a file and generates a new Scripteasy instance using those scripts.

Public Constructor
public	constructor(scripts: object) Creates a new Scripteasy instance.

Public Members
public	scripts: Array<Script>

Public Methods
public	parseScripts(scripts: object): Array<Script> Parses the scripts for a new Scripteasy instance.
public	run(name: string, args: Array<string>): Error Runs a script by name.

Reads scripts from a file and generates a new Scripteasy instance using those scripts.

Name	Type	Attribute	Description
filename	string		The name of the file.

A new Scripteasy instance.

Creates a new Scripteasy instance.

Name	Type	Attribute	Description
scripts	object		A map of scripts keyed by name. Each top level value is passed into the `Script` constructor as either the whole `opts` object or as the `opts.try` value.

Parses the scripts for a new Scripteasy instance.

Name	Type	Attribute	Description
scripts	object		A map of scripts.

The parsed scripts.

Runs a script by name.

Name	Type	Attribute	Description
name	string		The name of the script to run.
args	Array<string>	optional	The args to pass into the script.

If an error occurs, the error is returned.