Class Helper

Provides to parse arguments by the given template.

export
default: Helper

Hierarchy

PropsClass
- Helper

Implements

IPropClass

Index

Constructors

constructor

Properties

props

Methods

Object literals

defaultProps

Constructors

constructor

new Helper(props: TemplateProps, readers?: object): Helper

Overrides PropsClass.__constructor
- Defined in api/Helper.ts:21
Parameters
- props: TemplateProps
- Optional readers: object
  - [key: string]: Reader
Returns Helper

Properties

props

props: TemplateProps

Methods

getProps

getProps(): TemplateProps

- Defined in api/Helper.ts:125
Returns TemplateProps

help

help(template: TemplateProps, result: ResultOption): void

- Defined in api/Helper.ts:116
Checks help command and if help is exist then call HelpBoard.

Parameters
- template: TemplateProps
- result: ResultOption
Returns void

parse

parse(args: Array<string>): ResultOption

- Defined in api/Helper.ts:33
Parse arguments by the given template.

Parameters
- args: Array<string>
Returns ResultOption

Static bindAll

bindAll(instance: Object): void

Inherited from Class.bindAll
- Defined in /Users/kamilbukum/DEV/kbukum/command-helper/node_modules/wasabi-common/lib/lang/Class.d.ts:14
Binds all methods which is not a exist in restricted list

Parameters
- instance: Object
  
  to bind
Returns void

Object literals

Static Private defaultProps

defaultProps: object

addDefaults

addDefaults: boolean = true

readers

readers: "api/Readers" = Readers

Generated using TypeDoc