Collector | @jib/cli

Hierarchy

EventEmitter
- Collector

Index

Constructors

constructor

Properties

defaultMaxListeners

Methods

Constructors

constructor

new Collector(name: string, description?: string): Collector

- Defined in collector.ts:99
Parameters
- name: string
- Optional description: string
Returns Collector

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1032
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

argShift

argShift(args: string[]): string[]

- Defined in collector.ts:274
resolve argument-only and reduce original args to remaining options

Parameters
- args: string[]
Returns string[]

argument

argument(...args: ICommandArgument[]): this

- Defined in collector.ts:153
Parameters
- Rest ...args: ICommandArgument[]
Returns this

description

description(): string
description(desc: string): this

- Defined in collector.ts:113
Returns string
- Defined in collector.ts:114
Parameters
- desc: string
Returns this

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1044
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1045
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1041
Returns number

help

help(opt?: ICommandOption): this

- Defined in collector.ts:135
Parameters
- Optional opt: ICommandOption
Returns this

isOpt

isOpt(arg: string): boolean

- Defined in collector.ts:184
Parameters
- arg: string
Returns boolean

isRoot

isRoot(): boolean

- Defined in collector.ts:174
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1046
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1042
Parameters
- event: string | symbol
Returns Function[]

name

name(): string
name(name: string): this

- Defined in collector.ts:107
Returns string
- Defined in collector.ts:108
Parameters
- name: string
Returns this

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1038
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: OPTION, listener: IResolvedOptionListener<any>): this
on(event: VERSION, listener: IResolvedOptionListener<boolean>): this
on(event: HELP, listener: IResolvedHelpListener): this
on(event: PARSE, listener: function): this
on(event: string, listener: function): this

Overrides EventEmitter.on
- Defined in collector.ts:206
Parameters
- event: OPTION
- listener: IResolvedOptionListener<any>
Returns this
Overrides EventEmitter.on
- Defined in collector.ts:207
Parameters
- event: VERSION
- listener: IResolvedOptionListener<boolean>
Returns this
Overrides EventEmitter.on
- Defined in collector.ts:208
Parameters
- event: HELP
- listener: IResolvedHelpListener
Returns this
Overrides EventEmitter.on
- Defined in collector.ts:209
Parameters
- event: PARSE
- listener: function
  - - (result: ICollectorResult): void
    - Parameters
      - result: ICollectorResult
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in collector.ts:210
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

onHelp

onHelp(listener: IResolvedHelpListener): this

- Defined in collector.ts:228
alias for help event

Parameters
- listener: IResolvedHelpListener
Returns this

onOption

onOption<T>(name: string, listener: IResolvedOptionListener<T>): this

- Defined in collector.ts:220
listener for named option

Type parameters
- T
Parameters
- name: string
- listener: IResolvedOptionListener<T>
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1034
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

optRight

optRight(args: string[]): string[]

- Defined in collector.ts:284
restructure args such that all opts and values are preceded by the "args"

Parameters
- args: string[]
Returns string[]

option

option(...opts: ICollectorOption[]): this

- Defined in collector.ts:139
Parameters
- Rest ...opts: ICollectorOption[]
Returns this

parent

parent(p?: Collector): Collector

- Defined in collector.ts:158
Parameters
- Optional p: Collector
Returns Collector

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1035
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1036
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1043
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1039
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1037
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resolve

resolve(argv: string[]): Promise<ICollectorResult>

- Defined in collector.ts:236
resolve process arguments into a parsed set of options/args

Parameters
- argv: string[]
  
  sliced process.argv
Returns Promise<ICollectorResult>

result

result(): ICollectorResult

- Defined in collector.ts:266
Returns ICollectorResult

root

root(): Collector

- Defined in collector.ts:166
Returns Collector

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1040
Parameters
- n: number
Returns this

subcommand

subcommand(name: string, description?: string): Collector

- Defined in collector.ts:178
Parameters
- name: string
- Optional description: string
Returns Collector

unknowns

unknowns(allow: boolean): this

- Defined in collector.ts:119
Parameters
- allow: boolean
Returns this

usage

usage(): ICollectorSummary

- Defined in collector.ts:188
Returns ICollectorSummary

version

version(): string
version(v: string, opt?: ICommandOption): this

- Defined in collector.ts:123
Returns string
- Defined in collector.ts:124
Parameters
- v: string
- Optional opt: ICommandOption
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /Users/mtvander/dev/foss/jib/cli/node_modules/@types/node/index.d.ts:1029
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number