External module "argv"

Index

Variables

Functions

Variables

_args

_args: string[] = process.argv.slice(0)

_baseArgs

_baseArgs: string[] = _args.slice(2)

_cmds

_cmds: any[] = []

_exclude

_exclude: any[] = []

_flagExp

_flagExp: RegExp = /^--?/

_flags

_flags: object

Type declaration

_optionArgs

_optionArgs: string[] = _baseArgs.slice(1)

Functions

find

find(valid: string[], args?: string[]): any

- Defined in argv.ts:90
Find Iterates expected or valid values stopping if matching value is found in provided args.

Parameters
- valid: string[]
  
  array of expected valid values.
- Optional args: string[]
  
  array of params to inspect.
Returns any

isFlag

isFlag(flag: string): false | "value" | "boolean"

- Defined in argv.ts:31
Is Flag Checks if value is type of flag param.

Parameters
- flag: string
  
  the value to inspect to detect if is flag.
Returns false | "value" | "boolean"

parse

parse(args?: any[]): object

- Defined in argv.ts:67
Parameters
- Optional args: any[]
Returns object
- cmd: string
- cmds: any[]
- flags: object
  - [key: string]: any

parseElement

parseElement(val: string, idx: number, args: any[]): Object

- Defined in argv.ts:48
Parse Element Inspects value parses value as command or flag.

Parameters
- val: string
  
  the value to inspect/convert to flag.
- idx: number
  
  the current index position of the value.
- args: any[]
  
  the array of argv params.
Returns Object

Generated using TypeDoc