jackspeak

USAGE

`jack(options: JackOptions = {}) => Jack`

`Jack.heading(text: string, level?: 1 | 2 | 3 | 4 | 5 | 6)`

`Jack.description(text: string, { pre?: boolean } = {})`

Option Definitions

`Jack.flag({ [option: string]: definition, ... })`

`Jack.flagList({ [option: string]: definition, ... })`

`Jack.num({ [option: string]: definition, ... })`

`Jack.numList({ [option: string]: definition, ... })`

`Jack.opt({ [option: string]: definition, ... })`

`Jack.optList({ [option: string]: definition, ... })`

`Jack.addFields({ [option: string]: definition, ... })`

Informative Getters

`Jack.definitions`

`Jack.jackOptions`

`Jack.shorts`

`Jack.usageFields`

Actions

`Jack.parse(args: string[] = process.argv): { positionals: string[], values: OptionsResults }`

`Jack.validate(o: any): asserts o is OptionsResults`

`Jack.usage(): string`

`Jack.setConfigValues(options: OptionsResults, src?: string)`

`Jack.usageMarkdown(): string`

Some Example Code

Name