fynjs API
    Preparing search index...

    Interface VisualExecOptions

    interface VisualExecOptions {
        checkStdoutError?: boolean | RegExp;
        command: string;
        cwd?: string;
        displayTitle?: string;
        forceStderr?: boolean;
        logLabel?: string;
        matchers?: OutputMatcher[];
        maxBuffer?: number;
        onComplete?: OnCompleteCallback;
        onOutput?: OnOutputCallback;
        onProgress?: (
            progress: { current?: number; percent?: number; total?: number },
        ) => void;
        onTimeout?: () => void;
        outputFile?: string | WritableStream;
        outputFileOptions?: OutputFileOptions;
        outputLabel?: string;
        outputLevel?: string;
        progress?: ProgressExtractor;
        signal?: AbortSignal;
        spinner?: string | number | boolean;
        timeout?: number;
        timeoutGrace?: number;
        visualLogger?: VisualLogger;
    }
    Index
    checkStdoutError? command cwd? displayTitle? forceStderr? logLabel? matchers? maxBuffer? onComplete? onOutput? onProgress? onTimeout? outputFile? outputFileOptions? outputLabel? outputLevel? progress? signal? spinner? timeout? timeoutGrace? visualLogger?
    checkStdoutError?: boolean | RegExp

    Regex or boolean to check stdout for error patterns (default: true)

    command: string

    The command to execute

    cwd?: string

    Working directory for the command

    displayTitle?: string

    Title displayed during execution

    forceStderr?: boolean

    Force stderr output to be logged as error (default: true)

    logLabel?: string

    Label used in log messages

    matchers?: OutputMatcher[]

    Regex matchers for output lines

    maxBuffer?: number

    Maximum buffer size for stdout/stderr (default: 10MB)

    onComplete?: OnCompleteCallback

    Called after command completes. Return value passed through to execute() when exitCode is 0

    onOutput?: OnOutputCallback

    Called on each chunk of stdout/stderr during execution

    onProgress?: (
        progress: { current?: number; percent?: number; total?: number },
    ) => void

    Called when progress is extracted

    onTimeout?: () => void

    Callback before killing on timeout

    outputFile?: string | WritableStream

    Stream output to file (path or stream)

    outputFileOptions?: OutputFileOptions

    Options for outputFile when path string

    outputLabel?: string

    Label used in output messages

    outputLevel?: string

    Log level for output (default: "verbose")

    progress?: ProgressExtractor

    Progress extraction config

    signal?: AbortSignal

    AbortSignal for cancellation (e.g. from AbortController)

    spinner?: string | number | boolean

    Spinner style to use

    timeout?: number

    Timeout in milliseconds. Process killed if exceeded.

    timeoutGrace?: number

    Grace period in ms before SIGKILL after SIGTERM (default: 5000)

    visualLogger?: VisualLogger

    Visual logger instance to use

    Settings
    Member Visibility

    On This Page
    Properties