Class DocometCommander

Commander

See

Hierarchy (View Summary)

DocometInspectableObjectClass
- DocometCommander

Index

Constructors

Accessors

baseCommandName command packageJson

Methods

addHelpText addOption toJSON toString new runAsync

Constructors

constructor

new DocometCommander(baseCommandName: string): DocometCommander
Creates a DocometCommander instance
Parameters
- baseCommandName: string
  The base command name
Returns DocometCommander
Overrides DocometInspectableObjectClass.constructor
- Defined in src/docomet-commander.ts:92

Accessors

baseCommandName

get baseCommandName(): string
Base command name

Returns string
- Defined in src/docomet-commander.ts:79

command

get command(): Command
The Command object from commander

Returns Command
- Defined in src/docomet-commander.ts:86

`Static`packageJson

get packageJson(): DocometCommanderPackageJson
Package JSON (name | version)

Returns DocometCommanderPackageJson
- Defined in src/docomet-commander.ts:34

Methods

addHelpText

addHelpText(text: string): DocometCommander
Add a help text
Parameters
- text: string
  The help text
Returns DocometCommander
DocometCommander instance
- Defined in src/docomet-commander.ts:131

addOption

addOption(
    flags: string,
    description: string,
    required?: boolean,
    defaultValue?: string,
    choices?: string[],
): DocometCommander
Add an option
Parameters
- flags: string
  Option flags
- description: string
  Option description
- required: boolean = false
  Required flag
- OptionaldefaultValue: string
  Default value
- choices: string[] = []
  Choices for the option
Returns DocometCommander
DocometCommander instance
- Defined in src/docomet-commander.ts:111

toJSON

toJSON(): object
Convert to a JSON object

Returns object
The JSON object representation
- Defined in src/docomet-commander.ts:148

toString

toString(): string
Convert to a string

Returns string
The string representation
Overrides DocometInspectableObjectClass.toString
- Defined in src/docomet-commander.ts:140

`Static`new

new(...args: [baseCommandName: string]): DocometCommander
Creates a DocometCommander instance
Parameters
- ...args: [baseCommandName: string]
  The arguments for the constructor
Returns DocometCommander
DocometCommander instance
- Defined in src/docomet-commander.ts:70

`Static`runAsync

runAsync(callback: DocometCommanderRunAsyncCallback): Promise<void>
Runs the command asynchronously
Parameters
- callback: DocometCommanderRunAsyncCallback
  The callback function
Returns Promise<void>
A Promise that resolves when the command execution is complete
- Defined in src/docomet-commander.ts:52