Type Alias AbstractBaseCommand

Abstract command defines the mandatory properties on a command class needed by the internals of ace.

type AbstractBaseCommand = {
    commandName: string;
    options: CommandOptions;
    serialize(): CommandMetaData;
    validate(parsedOutput: ParsedOutput): void;
    getParserOptions(
        options?: FlagsParserOptions,
    ): {
        flagsParserOptions: Required<FlagsParserOptions>;
        argumentsParserOptions: ArgumentsParserOptions[];
    };
    new (...args: any[]): { hydrate(): void; exitCode?: number };
}

new AbstractBaseCommand(...args: any[]): { hydrate(): void; exitCode?: number }
Parameters
- ...args: any[]
Returns { hydrate(): void; exitCode?: number }
- Defined in src/types.ts:412

Index

Properties

commandName options

Methods

serialize validate getParserOptions

Properties

commandName

commandName: string

options

options: CommandOptions

Methods

serialize

serialize(): CommandMetaData
Returns CommandMetaData
- Defined in src/types.ts:406

validate

validate(parsedOutput: ParsedOutput): void
Parameters
- parsedOutput: ParsedOutput
Returns void
- Defined in src/types.ts:407

getParserOptions

getParserOptions(
    options?: FlagsParserOptions,
): {
    flagsParserOptions: Required<FlagsParserOptions>;
    argumentsParserOptions: ArgumentsParserOptions[];
}
Parameters
- Optionaloptions: FlagsParserOptions
Returns {
flagsParserOptions: Required<FlagsParserOptions>;
argumentsParserOptions: ArgumentsParserOptions[];
}
- Defined in src/types.ts:408