Class YargsCliExtractor

Parses CLI args using the yargs library. Specific settings can be enabled through the provided options.

Hierarchy

CliExtractor
- YargsCliExtractor

Index

Constructors

Properties

yargsArgOptions yargvOptions

Methods

canHandle createYArgv handle handleSafe

Constructors

constructor

new YargsCliExtractor(parameters, options): YargsCliExtractor
Range
JSON parameters cannot be optional due to https://github.com/LinkedSoftwareDependencies/Components-Generator.js/issues/87
Parameters
- parameters: YargsParameter[]
  
  Parameters that should be parsed from the CLI.
- options: CliOptions
  
  Additional options to configure yargs.
Returns YargsCliExtractor
Overrides CliExtractor.constructor
- Defined in src/init/cli/YargsCliExtractor.ts:57

Properties

`Protected` `Readonly` yargsArgOptions

yargsArgOptions: Record<string, Options>

`Protected` `Readonly` yargvOptions

yargvOptions: CliOptions

Methods

canHandle

canHandle(input): Promise<void>
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: CliArgv
  
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from CliExtractor.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:17

`Private` createYArgv

createYArgv(argv): Argv<{}>
Creates the yargs Argv object based on the input CLI argv.
Parameters
- argv: readonly string[]
Returns Argv<{}>
- Defined in src/init/cli/YargsCliExtractor.ts:72

handle

handle(argv): Promise<{
    $0: string;
    _: (string | number)[];
    [argName: string]: unknown;
}>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.
Parameters
- argv: readonly string[]
  
  Input that needs to be handled.
Returns Promise<{
    $0: string;
    _: (string | number)[];
    [argName: string]: unknown;
}>
A promise resolving when handling is finished.
Overrides CliExtractor.handle
- Defined in src/init/cli/YargsCliExtractor.ts:65

handleSafe

handleSafe(input): Promise<Shorthand>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: CliArgv
  
  Input data that will be handled if it can be handled.
Returns Promise<Shorthand>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from CliExtractor.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:38