Function parse

parse<T extends Readonly<Record<string, Option>>>(
    options: T,
    cmdLine?: CommandLine,
    flags?: ParsingFlags,
): Promise<
    Readonly<
        {
            [key in string
            | number
            | symbol as OptionKeyType<T[key], key>]: 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 as OptionKeyType<T[key], key>]: OptionDataType<T[key]>
        },
    >,
>
The frozen option values
- Defined in packages/tsargp/src/library/parser.ts:287