mwbot-ts - v1.2.7
    Preparing search index...

    Interface Parameter

    Object that holds information about a {{{parameter}}}, parsed from wikitext.

    This object is returned by Wikitext.parseParameters.

    interface Parameter {
        children: Set<number>;
        endIndex: number;
        index: number;
        key: string;
        nestLevel: number;
        parent: null | number;
        skip: boolean;
        startIndex: number;
        text: string;
        value: null | string;
    }
    Index

    Properties

    children: Set<number>

    The indices of the child Parameter objects within the parseParameters result array.

    endIndex: number

    The ending index of the parameter in the wikitext (exclusive).

    index: number

    The index of this Parameter object within the result array returned by parseParameters.

    key: string

    The parameter key (i.e. the left operand of {{{key|value}}}).

    nestLevel: number

    The nesting level of the parameter.

    • 0 for parameters that are not nested inside another parameter.
    • Increments with deeper nesting.
    parent: null | number

    The index of the parent Parameter object within the parseParameters result array, or null if there is no parent.

    skip: boolean

    Whether the parameter appears inside an HTML tag specified in SkipTags.

    startIndex: number

    The starting index of the parameter in the wikitext.

    text: string

    The full wikitext representation of the parameter.

    value: null | string

    The parameter value (i.e., the right operand of {{{key|value}}}).

    If the parameter is not pipe-separated, this property is null.