Class Cli<ConfigType>

Type Parameters

ConfigType extends Record<string, unknown>

Hierarchy

Cli

Index

Constructors

Properties

DEFAULT_FILENAME DEFAULT_WATCH_INTERVAL

Methods

getArgs getConfig getRegistrationFilePath run

Constructors

constructor

new Cli<ConfigType>(opts: CliOpts<ConfigType>): Cli<ConfigType>
Type Parameters
- ConfigType extends Record<string, unknown>
Parameters
- opts: CliOpts<ConfigType>
  
  CLI options
Returns Cli<ConfigType>

Properties

`Static` DEFAULT_FILENAME

DEFAULT_FILENAME: string = "registration.yaml"

`Static` DEFAULT_WATCH_INTERVAL

DEFAULT_WATCH_INTERVAL: number = 2500

Methods

getArgs

getArgs(): null | CliArgs
Get the parsed arguments. Only set after run is called and arguments parsed.

Returns
The parsed arguments

Returns null | CliArgs

getConfig

getConfig(): null | ConfigType
Get the loaded and parsed bridge config. Only set after run() has been called.

Returns
The config

Returns null | ConfigType

getRegistrationFilePath

getRegistrationFilePath(): string
Get the path to the registration file. This may be different to the one supplied in the constructor if the user passed a -f flag.

Returns
The path to the registration file.

Returns string

run

run(args?: CliArgs): void
Run the app from the command line. Will parse sys args.
Parameters
- Optional args: CliArgs
Returns void

Generated using TypeDoc