@otris/jsdoc-tsd/src-out/Configuration.d.ts

JSDoc Template for generate typescript definition files from JSDoc comments

/**
 * Function for comparing version strings of since-tags
 * to determine if the passed in tagged version is in range
 * of the passed in latest version
 */
declare type VersionComparatorFunction = (taggedVersion: string, latestVersion: string) => boolean;
export declare class Configuration {
    /**
     * Indicates wether to skip since tag check or not
     */
    ignoreSinceTag: boolean;
    /**
     * Logs every item which is ignored by the since tag
     */
    logItemsSkippedBySince: boolean;
    /**
     * Ignores undocumented items
     */
    skipUndocumented: boolean;
    private _ignoreScopes;
    private _latestVersion;
    private _versionComparator;
    constructor(filePath?: string);
    /**
     * Scopes to ignore
     */
    get ignoreScopes(): string[];
    set ignoreScopes(val: string[]);
    /**
     * Latest version tag for the version comparator function
     */
    get latestVersion(): string;
    set latestVersion(value: string);
    set versionComparator(value: VersionComparatorFunction | string);
    /**
     * Determines if the tagged version is in range of the latest version
     * using the provided version comparator
     * @param taggedVersion Current version tag
     * @param latestVersion Latest version tag from config
     */
    compareVersions(taggedVersion: string, latestVersion: string, itemName: string): boolean;
    ignoreScope(scope: string): boolean;
    /**
     * Determines if the tagged version is in range of the latest version
     * by using semver-tags
     * @param taggedVersion Current version tag
     * @param latestVersion Latest version tag from config
     */
    private defaultVersionComparator;
    private loadFromFile;
    private parseVersionComparatorFromString;
}
export {};