Interface SpawnState<T>

interface SpawnState<T extends string | Uint8Array> {
    _promise: Promise<SpawnState<T>>;
    argv: string[];
    loading: boolean;
    proc: Spawn<T>;
    status?: null | number;
    stderr?: string;
    stdout?: T;
    argvPretty(): string;
    errorStringHTML(fullArgv: boolean): string;
    promise(): Promise<SpawnState<T>>;
}

Type Parameters

Properties

_promise argv loading proc status? stderr? stdout?

Methods

argvPretty errorStringHTML promise

Properties

_promise

_promise: Promise<SpawnState<T>>

The promise that resolves when proc finishes

argv

argv: string[]

Copy of argv passed to useSpawn

loading

loading: boolean

Whether or not the process is still running

proc

proc: Spawn<T>

Process handle returned from cockpit.spawn()

Optional status

status?: null | number

Exit code of the process

Optional stderr

stderr?: string

Output of process printed to stderr

Optional stdout

stdout?: T

Output of process printed to stdout

Methods

argvPretty

errorStringHTML

  • errorStringHTML(fullArgv: boolean): string

  • Get HTML formatted error message with exit code and argv if specified

    Parameters

    • fullArgv: boolean

      Print full argv with message

    Returns string

promise

Settings

Member Visibility

Theme

On This Page

_promiseargvloadingprocstatusstderrstdoutargvPrettyerrorStringHTMLpromise