brepjs API Reference
    Preparing search index...

    Interface BrepError

    Structured error returned inside Result<T> on failure.

    Every error carries a kind (category), a machine-readable code, and a human-readable message. Optional cause preserves the original exception, and metadata holds extra context.

    The optional suggestion field provides actionable recovery hints.

    interface BrepError {
        cause?: unknown;
        code: string;
        kind: BrepErrorKind;
        message: string;
        metadata?: Readonly<Record<string, unknown>>;
        suggestion?: string;
    }
    Index

    Properties

    cause?: unknown
    code: string
    message: string
    metadata?: Readonly<Record<string, unknown>>
    suggestion?: string