Type Alias WithArgInfo

WithArgInfo: { index: number; name: string; values: OpaqueOptionValues }

Information about the current argument sequence in the parsing loop.

Type declaration

  • index: number

    The index of the occurrence of the option name, or of the first option parameter. It will be NaN if the sequence comes from environment data.

  • name: string

    The option name as specified on the command-line, or the environment data source. It will be the preferred name if the sequence comes from positional arguments. It will be the string '0' if the sequence comes from the standard input.

  • values: OpaqueOptionValues

    The previously parsed values. It is an opaque type that should be cast to OptionValues<typeof your_options>.