TypeDoc API - v0.28.14
    Preparing search index...

    Interface StringDeclarationOption

    interface StringDeclarationOption {
        help: () => string;
        name: string;
        configFileOnly?: boolean;
        defaultValue?: string;
        hint?: Configuration.ParameterHint;
        outputShortcut?: string;
        type?: String | Path | UrlOrPath;
        validate?: (value: string) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    help name configFileOnly? defaultValue? hint? outputShortcut? type? validate?

    Properties

    help: () => string

    The help text to be displayed to the user when --help is passed.

    This may be a string, which will be presented directly, or a function, which will be called so that option help can be translated into the user specified locale.

    name: string

    The option name.

    configFileOnly?: boolean

    If set, this option will be omitted from --help, and attempting to specify it on the command line will produce an error.

    defaultValue?: string

    If not specified defaults to the empty string for all types.

    hint?: Configuration.ParameterHint

    An optional hint for the type of input expected, will be displayed in the help output.

    outputShortcut?: string

    If specified, when this output is specified TypeDoc will automatically add an output to the outputs option whose name is the value of this property with the path set to the value of this option. Should only be used with type set to ParameterType.Path.

    If any output shortcuts are set, the outputs option will be ignored.

    type?: String | Path | UrlOrPath

    Specifies the resolution strategy. If Path is provided, values will be resolved according to their location in a file. If String or no value is provided, values will not be resolved.

    validate?: (value: string) => void

    An optional validation function that validates a potential value of this option. The function must throw an Error if the validation fails and should do nothing otherwise.

    Settings

    Member Visibility

    On This Page

    Properties