Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandBuilder

A build for Vert.x Shell command.

Hierarchy

  • CommandBuilder

Index

Methods

build

  • Build the command

    Parameters

    • vertx: Vertx

    Returns Command

completionHandler

  • Set the command completion handler, the completion handler when the user asks for contextual command line completion, usually hitting the tab key.

    Parameters

    Returns CommandBuilder

processHandler

  • Set the command process handler, the process handler is called when the command is executed.

    Parameters

    Returns CommandBuilder

Static command

  • Create a new commmand builder, the command is responsible for managing the options and arguments via the [#args() arguments] CommandProcess.

    Parameters

    • name: string

    Returns CommandBuilder

  • Create a new commmand with its {@link CLI} descriptor. This command can then retrieve the parsed {@link CommandProcess#commandLine} when it executes to know get the command arguments and options.

    Parameters

    • cli: CLI

    Returns CommandBuilder

Generated using TypeDoc