Interface ICliCommandProcessor

Represents a command processor

interface ICliCommandProcessor {
    allowUnlistedCommands?: boolean;
    author?: ICliCommandAuthor;
    command: string;
    description?: string;
    hooks?: ICliProcessorHook[];
    metadata?: CliProcessorMetadata;
    parameters?: ICliCommandParameterDescriptor[];
    processors?: ICliCommandChildProcessor[];
    stateConfiguration?: CliStateConfiguration;
    validateBeforeExecution?: (
        command: CliProcessCommand,
        context: ICliExecutionContext,
    ) => { message?: string; valid: boolean };
    valueRequired?: boolean;
    version?: string;
    initialize(context: ICliExecutionContext): Promise<void>;
    processCommand(
        command: CliProcessCommand,
        context: ICliExecutionContext,
    ): Promise<void>;
    writeDescription(context: ICliExecutionContext): void;
}

Hierarchy (View Summary)

Properties

allowUnlistedCommands? author? command description? hooks? metadata? parameters? processors? stateConfiguration? validateBeforeExecution? valueRequired? version?

Methods

initialize? processCommand writeDescription?

Properties

OptionalallowUnlistedCommands

allowUnlistedCommands?: boolean

If true, the processor can handle unlisted commands

Default

false

Remarks

If true, the processor can handle unlisted commands. If false, the processor will only handle commands that are explicitly listed in the processors property

Optionalauthor

author?: ICliCommandAuthor

The author of the command

command

command: string

The command that this processor handles

Optionaldescription

description?: string

A description of the command

Optionalhooks

hooks?: ICliProcessorHook[]

Hooks that are executed before and after the command is processed

Optionalmetadata

metadata?: CliProcessorMetadata

The metadata for the command processor

Optionalparameters

parameters?: ICliCommandParameterDescriptor[]

Parameters that the command accepts

Optionalprocessors

processors?: ICliCommandChildProcessor[]

Processors that are nested under this processor

OptionalstateConfiguration

stateConfiguration?: CliStateConfiguration

Represents the state configuration for the command processor

Remarks

The state configuration is used to store and retrieve state information for the command processor

OptionalvalidateBeforeExecution

validateBeforeExecution?: (
    command: CliProcessCommand,
    context: ICliExecutionContext,
) => { message?: string; valid: boolean }

A function that validates the command before execution

Type declaration

    • (
          command: CliProcessCommand,
          context: ICliExecutionContext,
      ): { message?: string; valid: boolean }

    • Parameters

      Returns { message?: string; valid: boolean }

      An object with a valid property that indicates if the value is valid and an optional message property that contains a message to display if the value is not valid

OptionalvalueRequired

valueRequired?: boolean

If true, the value is required

Optionalversion

version?: string

The version of the command processor

Default

'1.0.0'

Methods

Optionalinitialize

processCommand

OptionalwriteDescription

Settings

Member Visibility

On This Page

Properties
Methods