Options
All
  • Public
  • Public/Protected
  • All
Menu

Converts the input CLI arguments into an easily parseable key/value object.

Due to how the application is built, there are certain CLI parameters that need to be parsed before this class can be instantiated. These can be ignored by this class as they will have been handled before it is called, but that does mean that this class should not error if they are present, e.g., by being strict throwing an error on these unexpected parameters.

The following core CLI parameters are mandatory:

  • -c / --config
  • -m / --mainModulePath
  • -l / --loggingLevel

Hierarchy

Index

Constructors

Methods

  • canHandle(input: CliArgv): 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.

  • handle(input: CliArgv): Promise<Settings>
  • Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

    Parameters

    • input: CliArgv

      Input that needs to be handled.

    Returns Promise<Settings>

    A promise resolving when handling is finished.

  • handleSafe(input: CliArgv): Promise<Settings>