Options
All
  • Public
  • Public/Protected
  • All
Menu

Contains processed argument data (usually from process.argv).

Hierarchy

  • ArgvData

Index

Properties

cleanExit

cleanExit: boolean

This flag instructs the caller of interpretArgv to exit cleanly. Eg. If --help was specified on the command line, interpretArgv will print a help message and set this flag.

dockerImage

dockerImage: string

The Docker Image specified by the user (eg. ubuntu:latest).

invalidArguments

invalidArguments: boolean

This flag indicates interpretArgv that incorrect arguments were given to the CLI. The caller should print an error message to the console, then exit with an error code.

makefile

makefile: undefined | string

Unused; right now, it's hardcoded to 'Makefile'.

Its intent was to capture the makefile specified by the user (eg. build.make), and to be undefined when no Makefile was specified.

We cut this functionality due to time constraints; it's preserved here for compatibility + futureproofing.

targets

targets: string[]

A list of build targets specified by the user (eg. [all, a.out, clean]). This list is empty if no targets were specified.

Generated using TypeDoc