@canalplus/readme.doc/build/anchor_checker.d.ts

Readme's an Extremely Accessible Documentation MakEr

/** Item returned by the `AnchorChecker` once it checks anchors. */
export interface AnchorCheckerErrorItem {
    /** The input file which had a link to an anchor. */
    inputFileWithLink: string;
    /**
     * The target input file where the anchor should be found.
     * May be the same than `inputFileWithLink` for local anchors.
     */
    inputFileLinkDestination: string;
    /** The actual anchor. */
    anchor: string;
    /** The result of the validity check for that anchor. */
    validity: AnchorValidity;
}
/** Result of an anchor's validity check performed by the `AnchorChecker`. */
export declare const enum AnchorValidity {
    /** The anchor has been found in the corresponding file. */
    Found = 0,
    /** The target input file was not found. */
    FileNotFound = 1,
    /** The anchor has not been found in the corresponding file. */
    AnchorNotFound = 2
}
/**
 * Specialized class here to store then check availability of documentation
 * "anchors" referenced in the various pages.
 * @class AnchorChecker
 */
export default class AnchorChecker {
    /**
     * Map linking input files to all anchors generated for that file (e.g. for
     * headers).
     * This Map is updated by `addAnchorsForFile`.j ks
     */
    private _anchorsPerFile;
    /** Current list of anchors seen in the various files. */
    private _anchorsList;
    constructor();
    /**
     * Add a list of anchors set in a particular input file.
     * @param {string} inputFile - The Markdown file from which the anchors are.
     * @param {Array.<string>} anchors - Every anchors in that file.
     */
    addAnchorsForFile(inputFile: string, anchors: string[]): void;
    /**
     * Adds a reference to an anchor seen in an input file.
     *
     * This method doesn't check the validity of that anchor yet, it just adds
     * it to the `AnchorChecker`'s local queue of referenced anchors which can
     * then be checked all at once by calling `checkAllAnchors`.
     * @param {string} inputFileWithLink - The input file where the anchored link
     * was found.
     * @param {string} inputFileLinkDestination - The targeted input file where
     * the anchor should be found.
     * @param {string} anchor - The actual anchor.
     */
    addAnchorReference(inputFileWithLink: string, inputFileLinkDestination: string, anchor: string): void;
    /**
     * Check the validity of all anchors added through `addAnchorReference`
     * method calls and return descriptions of checks which failed.
     * @returns {Array.<Object>} - Description of every anchor check that
     * failed, or an empty array if all anchors are valid.
     */
    checkAllAnchors(): AnchorCheckerErrorItem[];
    /**
     * Check the validity of a single anchor according to what has been
     * communicated previously to the `AnchorChecker`.
     * @param {string} file - The input file which that anchor applies to.
     * @param {string} anchor - The actual anchor
     * @returns {number} - Number describing that anchor's validity.
     */
    checkValidAnchor(file: string, anchor: string): AnchorValidity;
    /**
     * Returns all anchors available in an input file according to what has been
     * communicated previously to the `AnchorChecker`.
     *
     * Returns `undefined` if the input file was never added to the
     * `AnchorChecker`.
     * @returns {Array.<string>|undefined}
     */
    getAnchorsForInputFile(inputFile: string): string[] | undefined;
}