clyops Node API
    Preparing search index...

    Interface ToolResult

    Tool execution outcome, including success and parsed JSON output when available.

    interface ToolResult {
        command: string[];
        durationMs: number;
        exitCode: number | null;
        json?: unknown;
        ok: boolean;
        signal: string | null;
        stderr: string;
        stdout: string;
        stdoutBuffer?: Buffer<ArrayBufferLike>;
        timedOut: boolean;
        truncated?: boolean;
    }

    Hierarchy (View Summary)

    Index
    command durationMs exitCode json? ok signal stderr stdout stdoutBuffer? timedOut truncated?
    command: string[]

    Executed command words, including executable and arguments.

    durationMs: number

    Elapsed execution time in milliseconds.

    exitCode: number | null

    Process exit code, or null when terminated by a signal or not started.

    json?: unknown

    stdout parsed as JSON, when it is JSON.

    ok: boolean

    Whether the tool finished without timeout, signal, or a nonzero exit code.

    signal: string | null

    Termination signal, or null for an ordinary exit.

    stderr: string

    Captured stderr as text.

    stdout: string

    Captured stdout as text; binary and streaming modes have separate outputs.

    stdoutBuffer?: Buffer<ArrayBufferLike>

    stdout as bytes, with stdout: 'buffer'.

    timedOut: boolean

    Whether the execution deadline was reached.

    truncated?: boolean

    Output beyond maxOutput was dropped.

    Settings
    Member Visibility

    On This Page
    Properties