TypeDoc API - v0.28.2

    Class ArgumentsReader

    Obtains option values from command-line arguments

    Implements

    Index

    Constructors

    Methods

    Properties

    Constructors

    Methods

    Properties

    name: "arguments"

    The name of this reader so that it may be removed by plugins without the plugin accessing the instance performing the read. Multiple readers may have the same name.

    order: number

    Readers will be processed according to their orders. A higher order indicates that the reader should be called later.

    Note that to preserve expected behavior, the argv reader must have both the lowest order so that it may set the location of config files used by other readers and the highest order so that it can override settings from lower order readers.

    supportsPackages: false

    Flag to indicate that this reader should be included in sub-options objects created to read options for packages mode.

    MMNEPVFCICPMFPCPTTAAATR