ScriptExecution

engines.ScriptExecution

Handle returned by execScriptFile: tracks which file ran, exposes the underlying ScriptEngine, and emits lifecycle events.

Inheritance

• EventEmitter

  ↳ ScriptExecution

Table of contents

Properties

• source
• sourceFile

Accessors

• engineOrNull
• executionConfig

Methods

• engine

Events

• on

Properties

source

• source (read-only): any

Opaque caller context for this run (implementation-defined).

sourceFile

• sourceFile (read-only): string

Absolute path of the script file being executed.

Accessors

engineOrNull

• engineOrNull (getter): ScriptEngine | null

The live engine if it already exists; otherwise null (no waiting).

Returns

ScriptEngine | null

executionConfig

• executionConfig (getter): ReadOnlyExecutionConfig

Frozen snapshot of path / cwd / project options for this execution.

Returns

ReadOnlyExecutionConfig

Methods

engine

engine(): Promise<ScriptEngine>

Waits until the child ScriptEngine is ready, then resolves with it.

Example

"nodejs";
const { execScriptFile } = require("engines");

const execution = execScriptFile("/sdcard/script.js");

execution.engine().then((engine) => {
    console.log("Engine ID:", engine.id);
    console.log("Working directory:", engine.workingDirectory);
    engine.emit("custom_event", "data");
});

Returns

Promise<ScriptEngine>

Events

on

on(event: "start" | "success" | "exception", listener: (...args: any[]) => void): ScriptExecution

Subscribe to start, success, or exception for this execution.

Parameters

• event: "start" | "success" | "exception"
• listener: Callback invoked with event-specific arguments.

Returns

ScriptExecution — this for chaining.