Class YargsParameter

This class exists as wrapper around a yargs Options object, thereby allowing us to create these in a Components.js configuration.

Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt

Hierarchy

  • YargsParameter

Constructors

constructor

Properties

name options

Constructors

constructor

  • Range

    Parameters

    • name: string

      Name of the parameter. Corresponds to the first parameter passed to the yargs.options function.

    • options: Record<string, any>

      Options for a single parameter that should be parsed.

    Returns YargsParameter

Properties

Readonly name

name: string

Readonly options

options: Options

Settings

Member Visibility

Theme

On This Page