Function parse

  • parse<T extends Readonly<Record<string, Option>>>(
        options: T,
        cmdLine?: CommandLine,
        flags?: ParsingFlags,
    ): Promise<
        { -readonly [key in string
        | number
        | symbol]: OptionDataType<T[key]> },
    >

    Parses command-line arguments into option values.

    Type Parameters

    • T extends Readonly<Record<string, Option>>

    Parameters

    • options: T

      The option definitions

    • OptionalcmdLine: CommandLine

      The command line or arguments

    • Optionalflags: ParsingFlags

      The parsing flags

    Returns Promise<{ -readonly [key in string | number | symbol]: OptionDataType<T[key]> }>

    The options' values

Settings

Member Visibility