InterfaceSubprocess

Class which allows you to trigger a subproccess outside of Lens Studio (e.g. a command line command).

interface Subprocess {
    command: string;
    onError: signal1<number, void>;
    onExit: signal2<number, number, void>;
    onStart: signal0<void>;
    onStateChange: signal1<number, void>;
    stderr: signal1<Buffer, void>;
    stdin: Writable;
    stdout: signal1<Buffer, void>;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    kill(): void;
    start(): void;
}

Hierarchy (view full)

Properties

command onError onExit onStart onStateChange stderr stdin stdout

Methods

getTypeName isOfType isSame kill start

Properties

Readonlycommand

command: string

The command for the subprocess.

ReadonlyonError

onError: signal1<number, void>

A handle for getting callback when a subprocess' state has errored.

ReadonlyonExit

onExit: signal2<number, number, void>

A handle for getting callback when a subprocess' state has exited.

ReadonlyonStart

onStart: signal0<void>

A handle for getting callback when a subprocess is started

ReadonlyonStateChange

onStateChange: signal1<number, void>

A handle for getting callback when a subprocess' state has changed.

Readonlystderr

stderr: signal1<Buffer, void>

A handle for getting callback when a subprocess' state has received stderr.

Readonlystdin

stdin: Writable

A handle for getting callback when a subprocess' state has received stdin.

Readonlystdout

stdout: signal1<Buffer, void>

A handle for getting callback when a subprocess' state has received stdout.

Methods

getTypeName

isOfType

isSame

kill

  • kill(): void

  • Kills a subprocess.

    Returns void

start

  • start(): void

  • Starts a subprocess.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods