@bearz/exec/types/errors.d.ts

The exec module makes it easy to spawn child_processes across different runtimes and different operating systems.

/**
 * The `errors` module provides error classes for handling command execution errors.
 *
 * @module
 */
/**
 * Represents an error that occurs when executing a command.
 */
export interface CommandErrorOptions extends ErrorOptions {
    /**
     * The exit code of the command.
     */
    code?: number;
    /**
     * The name of the command.
     */
    fileName?: string;
    /**
     * The arguments passed to the command.
     */
    args?: string[];
    /**
     * The descriptor of the target when the error occurred.
     */
    target?: string;
    /**
     * A link to more information about the error.
     */
    link?: string;
    /**
     * The error message.
     */
    message?: string;
    /**
     * The underlying cause of the error.
     */
    cause?: Error;
}
/**
 * Represents an error that occurs when executing a command.
 */
export declare class CommandError extends Error {
    /**
     * The exit code of the command.
     */
    exitCode?: number;
    /**
     * The name of the command.
     */
    fileName?: string;
    /**
     * The arguments passed to the command.
     */
    args?: string[];
    /**
     * The descriptor of the target when the error occurred.
     */
    target?: string;
    /**
     * A link to more information about the error.
     */
    link?: string;
    /**
     * Creates a new instance of the CommandError class.
     * @param options The options for the error.
     */
    constructor(options: CommandErrorOptions);
    /**
     * Creates a new instance of the CommandError class.
     * @param message The error message.
     */
    constructor(message?: string);
}
/**
 * Represents an error that occurs when a command is not found on the PATH.
 */
export interface NotFoundOnPathErrorOptions extends ErrorOptions {
    /**
     * The name or path of the command that was not found.
     */
    exe?: string;
    /**
     * The descriptor of the target when the error occurred.
     */
    target?: string;
    /**
     * A link to more information about the error.
     */
    link?: string;
    /**
     * The error message.
     */
    message?: string;
    /**
     * The underlying cause of the error.
     */
    cause?: Error;
}
export declare class NotFoundOnPathError extends Error {
    /**
     * The descriptor of the target when the error occurred.
     */
    target?: string;
    /**
     * A link to more information about the error.
     */
    link?: string;
    /**
     * The name or path of the command that was not found.
     */
    exe?: string;
    /**
     * Creates a new instance of the NotFoundOnPathError class.
     * @param options The options for the error.
     */
    constructor(options: NotFoundOnPathErrorOptions);
    /**
     * Creates a new instance of the NotFoundOnPathError class.
     * @param message The error message.
     */
    constructor(message: string);
    /**
     * Creates a new instance of the NotFoundOnPathError class.
     */
    constructor();
}