Class YargsCliExtractor

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

Hierarchy

CliExtractor
- YargsCliExtractor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new YargsCliExtractor(parameters?: YargsArgOptions, options?: CliOptions): YargsCliExtractor

Overrides CliExtractor.constructor
- Defined in src/init/cli/YargsCliExtractor.ts:35
Parameters
- parameters: YargsArgOptions = {}
  
  Parameters that should be parsed from the CLI. @range {json} Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt
- options: CliOptions = {}
  
  Additional options to configure yargs. @range {json}
Returns YargsCliExtractor

Properties

Protected Readonly yargsArgOptions

yargsArgOptions: YargsArgOptions

Protected Readonly yargvOptions

yargvOptions: CliOptions

Methods

canHandle

canHandle(input: CliArgv): Promise<void>

Inherited from CliExtractor.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
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.

Private createYArgv

createYArgv(argv: readonly string[]): Argv<{}>

- Defined in src/init/cli/YargsCliExtractor.ts:48
Creates the yargs Argv object based on the input CLI argv.

Parameters
- argv: readonly string[]
Returns Argv<{}>

handle

handle(argv: readonly string[]): Promise<{ $0: string; _: (string | number)[] }>

Overrides CliExtractor.handle
- Defined in src/init/cli/YargsCliExtractor.ts:41
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[]
Returns Promise<{ $0: string; _: (string | number)[] }>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: CliArgv): Promise<Settings>

Inherited from CliExtractor.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
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<Settings>
A promise resolving if the input can be handled, rejecting with an Error if not.