Variable ZOptionSyntax

Type declaration

• get any(): ZOptionSyntax

  Any command line option syntax.

  Supports name [value1 [value2 ...]] format. Uses * as a fallback option key.

  This is used as a fallback by default.

• by:function

  • by(this, syntax): ZOptionSyntax

  • Builds an option syntax supporting other syntaxes.

    Parameters

    • this: void

    • syntax: ZOptionSyntax | readonly ZOptionSyntax[]

      Either a single syntax, or an array of syntaxes to support.

    Returns ZOptionSyntax

    Either a single syntax passed in, or a syntax supporting all of them.

• get default(): ZOptionSyntax

  Default command line option syntax.

  Includes support for:

  • long options syntax,
  • short options syntax, and
  • any options syntax as a fallback.

• get longOptions(): ZOptionSyntax

  Long command line option syntax.

  Supports the following option formats:

  • --name=VALUE. Corresponding option key is --name.
  • --name [VALUE [VALUE ...]]. Corresponding option key is --name=VALUE, --name=*, or --name.

  Uses --*=* as a fallback option key for options in --name=VALUE format. Uses --* as a generic fallback option key.

  Enabled by default.

• get shortOptions(): ZOptionSyntax

  Short command line option syntax.

  Supports the following option formats:

  • -name=VALUE. Corresponding key is -name=VALUE, -name=*, or -name.
  • -name [VALUE [VALUE ...]]. Corresponding option key is -name.
  • -n[m[o...]][VALUE]. Corresponding option key is -n*.

  Uses -*=* as a fallback option key for options in -name=VALUE format. Uses -? as a fallback option key for one-letter options. Uses -* as a generic fallback option key.

  Enabled by default.