salve-annos/lib/salve/errors.d.ts

A fork with support for documentation of Salve, a Javascript library which implements a validator able to validate an XML document on the basis of a subset of RelaxNG.

/**
 * Validation errors.
 * @author Louis-Dominique Dubeau
 * @license MPL 2.0
 * @copyright Mangalam Research Center for Buddhist Languages
 */
import { Base } from "./name_patterns";
/**
 * The ``fireEvent`` methods return an array of objects of this class to
 * notify the caller of errors in the file being validated.
 *
 * Note that these error objects do not record what (element, attribute, text,
 * etc.) in the XML document was responsible for the error. It is the
 * responsibility of the code that uses salve to combine the error message with
 * an object that points into the document being validated.
 *
 * This is particularly important when considering the equality of errors. Two
 * errors are considered equal if their messages (with names) are the
 * same. *They could still be associated with two different locations in the
 * document being validated.* The code calling salve must distinguish such
 * cases.
 */
export declare class ValidationError {
    readonly msg: string;
    /**
     *
     * @param msg The error message.
     */
    constructor(msg: string);
    /**
     * The default implementation is to return the value of calling
     * ``this.toStringWithNames(this.getNames())``.
     *
     * @returns The text representation of the error.
     */
    toString(): string;
    /**
     * This method provides the caller with the list of all names that are used in
     * the error message.
     *
     * @returns The list of names used in the error message.
     */
    getNames(): Base[];
    /**
     * This method transforms this object to a string but uses the names in the
     * parameter passed to it to format the string.
     *
     * Since salve does not work with namespace prefixes, someone using salve
     * would typically use this method so as to replace the name patterns passed
     * in error messages with qualified names.
     *
     * @param names The array of names to use. This should be an array of the same
     * length as that returned by [[getNames]] . Each element of the array
     * corresponds to each name in [[getNames]] and should be something that can
     * be converted to a meaningful string.
     *
     * @returns The object formatted as a string.
     */
    toStringWithNames(names: any[]): string;
    /**
     * Two [[ValidationError]] objects are considered equal if the values returned
     * by [[toString]] are equal.
     *
     * @param other The other validation error to compare against.
     *
     * @returns Whether ``this`` and ``other`` are equal.
     */
    equals(other: ValidationError): boolean;
}
/**
 * This class serves as a base for all those errors that have only
 * one name involved.
 */
export declare class SingleNameError extends ValidationError {
    readonly name: Base;
    /**
     * @param msg The error message.
     *
     * @param name The name of the XML entity at stake.
     */
    constructor(msg: string, name: Base);
    getNames(): Base[];
    toStringWithNames(names: any[]): string;
}
/**
 * Error returned when an attribute name is invalid.
 */
export declare class AttributeNameError extends SingleNameError {
}
/**
 * Error returned when an attribute value is invalid.
 */
export declare class AttributeValueError extends SingleNameError {
}
/**
 * Error returned when an element is invalid.
 */
export declare class ElementNameError extends SingleNameError {
}
/**
 * Error returned when choice was not satisfied.
 */
export declare class ChoiceError extends ValidationError {
    readonly namesA: Base[];
    readonly namesB: Base[];
    /**
     * @param namesA The names of the first XML entities at stake.
     *
     * @param namesB The names of the second XML entities at stake.
     */
    constructor(namesA: Base[], namesB: Base[]);
    getNames(): Base[];
    toStringWithNames(names: any[]): string;
}