Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cli<ConfigType>

Type parameters

  • ConfigType: Record<string, unknown>

Hierarchy

  • Cli

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Cli<ConfigType>(opts: CliOpts<ConfigType>): 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 null | CliArgs

    The parsed arguments

getConfig

  • getConfig(): null | ConfigType

  • Get the loaded and parsed bridge config. Only set after run() has been called.

    Returns null | ConfigType

    The config

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 string

    The path to the registration file.

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