Class CliTodoCommandProcessor

Implements

  • ICliCommandProcessor

Constructors

constructor

Properties

author command description metadata? processors? stateConfiguration? version

Methods

initialize processCommand writeDescription

Constructors

constructor

Properties

author

author: ICliCommandAuthor = DefaultLibraryAuthor

The author of the command

command

command: string = 'todo'

The command that this processor handles

description

description: string = 'A command-line tool for managing your tasks efficiently. Add, list, complete, and remove TODO items with simple commands.'

A description of the command

Optionalmetadata

metadata?: CliProcessorMetadata = ...

The metadata for the command processor

Optionalprocessors

processors?: ICliCommandProcessor[] = []

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

version

version: string = LIBRARY_VERSION

The version of the command processor

Default

'1.0.0'

Methods

initialize

  • initialize(context: ICliExecutionContext): Promise<void>

  • Initialize the command processor

    Parameters

    • context: ICliExecutionContext

      The context in which the command is executed

    Returns Promise<void>

processCommand

  • processCommand(
        command: CliProcessCommand,
        context: ICliExecutionContext,
    ): Promise<void>

  • Process the command

    Parameters

    • command: CliProcessCommand

      The command to process

    • context: ICliExecutionContext

      The context in which the command is executed

    Returns Promise<void>

writeDescription

  • writeDescription(context: ICliExecutionContext): void

  • Write the description of the command

    Parameters

    • context: ICliExecutionContext

      The context in which the command is executed

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods