@microsoft/api-extractor/lib/DocElementParser.d.ts

Validate, document, and review the exported API for a TypeScript library

import { MarkupBasicElement } from './markup/MarkupElement';
import ApiDocumentation from './aedoc/ApiDocumentation';
import Token from './aedoc/Token';
import Tokenizer from './aedoc/Tokenizer';
export default class DocElementParser {
    /**
     * Used to validate the display text for an \@link tag.  The display text can contain any
     * characters except for certain AEDoc delimiters: "@", "|", "{", "}".
     * This RegExp matches the first bad character.
     * Example: "Microsoft's {spec}" --> "{"
     */
    private static _displayTextBadCharacterRegEx;
    /**
     * Matches a href reference. This is used to get an idea whether a given reference is for an href
     * or an API definition reference.
     *
     * For example, the following would be matched:
     * 'http://'
     * 'https://'
     *
     * The following would not be matched:
     * '@microsoft/sp-core-library:Guid.newGuid'
     * 'Guid.newGuid'
     * 'Guid'
     */
    private static _hrefRegEx;
    static parse(documentation: ApiDocumentation, tokenizer: Tokenizer): MarkupBasicElement[];
    static parseAndNormalize(documentation: ApiDocumentation, tokenizer: Tokenizer): MarkupBasicElement[];
    /**
     * This method parses the semantic information in an \@link JSDoc tag, creates and returns a
     * MarkupElement with the corresponding information. If the corresponding inline tag \@link is
     * not formatted correctly an error will be reported and undefined is returned.
     *
     * The format for the \@link tag is {\@link URL or API defintion reference | display text}, where
     * the '|' is only needed if the optional display text is given.
     *
     * Examples:
     * \{@link http://microsoft.com | microsoft home \}
     * \{@link http://microsoft.com \}
     * \{@link @microsoft/sp-core-library:Guid.newGuid | new Guid Object \}
     * \{@link @microsoft/sp-core-library:Guid.newGuid \}
     */
    static parseLinkTag(documentation: ApiDocumentation, tokenItem: Token): MarkupBasicElement | undefined;
    /**
     * This method parses the semantic information in an \@inheritdoc JSDoc tag and sets
     * all the relevant documenation properties from the inherited doc onto the documenation
     * of the current api item.
     *
     * The format for the \@inheritdoc tag is {\@inheritdoc scopeName/packageName:exportName.memberName}.
     * For more information on the format see IInheritdocRef.
     */
    static parseInheritDoc(documentation: ApiDocumentation, token: Token, warnings: string[]): void;
}