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

Index

Constructors

Properties

Constructors

constructor

new YargsParameter(name, options): YargsParameter
Parameters
- name: string
  Name of the parameter. Corresponds to the first parameter passed to the yargs.options function.
- options: Record<string, unknown>
  Options for a single parameter that should be parsed.
Returns YargsParameter
Range
- Defined in src/init/cli/YargsCliExtractor.ts:22

Properties

`Readonly`name

name: string

`Readonly`options

options: Options