Interface ResolvedCommand

Object containing details about the resolved command, the path to the command file, any parameters, and a function to resolve the next command, if any.

interface ResolvedCommand {
    command: CommandModule;
    commandName: string;
    commandPath: string;
    commandTokens: string[];
    params?: Params;
    remainingCommandString: string;
    resolveNext?: (() => Promise<ResolvedCommand>);
    subcommandsDir: string;
}

Properties

command commandName commandPath commandTokens params? remainingCommandString resolveNext? subcommandsDir

Properties

command

command: CommandModule

The command object associated with the resolved command.

commandName

commandName: string

The name of the resolved command.

commandPath

commandPath: string

The path to the resolved command file.

commandTokens

commandTokens: string[]

The command tokens that were resolved.

Optionalparams

params?: Params

The params associated with the resolved command.

remainingCommandString

remainingCommandString: string

The part of the command string that has not yet been resolved.

OptionalresolveNext

resolveNext?: (() => Promise<ResolvedCommand>)

A function to resolve the next command, if any, based on the remaining command string.

subcommandsDir

subcommandsDir: string

The path to the directory where the command's subcommands should live.

Settings

Member Visibility

On This Page

Properties