Show / Hide Table of Contents

    Interface KnownOption

    Package: grammarkdown

    Properties

    aliasFor

    Declaration
    aliasFor?: string[];
    Property Value
    Type Description
    string[]

    convert

    Declaration
    convert?: (key: string, value: string, raw: RawArguments) => any;
    Property Value
    Type Description
    (key: string, value: string, raw: RawArguments) => any

    description

    Declaration
    description?: string;
    Property Value
    Type Description
    string

    error

    Declaration
    error?: string;
    Property Value
    Type Description
    string

    hidden

    Declaration
    hidden?: boolean;
    Property Value
    Type Description
    boolean

    isUsage

    Declaration
    isUsage?: boolean;
    Property Value
    Type Description
    boolean

    longName

    Declaration
    longName: string;
    Property Value
    Type Description
    string

    many

    Declaration
    many?: boolean;
    Property Value
    Type Description
    boolean

    param

    Declaration
    param?: string;
    Property Value
    Type Description
    string

    shortName

    Declaration
    shortName?: string;
    Property Value
    Type Description
    string

    type

    Declaration
    type?: string | Map<string, any>;
    Property Value
    Type Description
    string | Map<string, any>

    validate

    Declaration
    validate?: (key: string, value: string, raw: RawArguments) => boolean;
    Property Value
    Type Description
    (key: string, value: string, raw: RawArguments) => boolean
    Back to top Generated by DocFX