External module "argv"

Index

Variables

Functions

Variables

_args

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

_command

_command: any = null

_commands

_commands: any[] = []

_flagExp

_flagExp: RegExp = /^--?/

_flags

_flags: object

Type declaration

_noFlagExp

_noFlagExp: RegExp = /^--no-/

_normalized

_normalized: any[] = []

Functions

castToType

castToType(val: any): any

- Defined in argv.ts:31
Cast To Type : Loosely tries to cast numbers and booleans.

Parameters
- val: any
  
  the value to be cast.
Returns any

filterArgs

filterArgs(args: any, exclude: any): any

- Defined in argv.ts:124
Filter Args : Filters an array of arguments by exclusion list.

Parameters
- args: any
  
  the arguments to be filtered.
- exclude: any
  
  the arguments to be excluded.
Returns any

flagsToArray

flagsToArray(flags: any): any[]

- Defined in argv.ts:45
Flags To Array : Convert flag object to array.

Parameters
- flags: any
  
  object containing flags.
Returns any[]

mergeArgs

mergeArgs(def: any, args: any, exclude?: any): any

- Defined in argv.ts:145
Merge Args : Merges two sets of command arguments.

Parameters
- def: any
  
  array of default args.
- args: any
  
  array of new args.
- Optional exclude: any
Returns any

normalizeArgs

normalizeArgs(args: any, exclude?: any): any

- Defined in argv.ts:91
Normalize : Spreads multi flag arguments and breaks arguments usign = sign.

example

-am: returns -a, -m. --flag=value: returns --flag, value.

Parameters
- args: any
  
  arguments to be normalized.
- Optional exclude: any
Returns any

parse

parse(args?: any, exclude?: any): object

- Defined in argv.ts:175
Parse : Parses command arguments.

Parameters
- Optional args: any
  
  the arguments to be parsed if null uses process.argv.slice(2)
- Optional exclude: any
  
  any flags or commands that should be excluded.
Returns object
- cmd: any
- cmds: any[]
- command: any
- commands: any[]
- flags: object
- normalized: any
- source: string[]

splitArgs

splitArgs(str: string | any[]): any[]

- Defined in argv.ts:63
Split Args : Splits string of command arguments honoring quotes.

Parameters
- str: string | any[]
  
  the string representing arguments.
Returns any[]

Generated using TypeDoc