@flowscripter/plugin-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface defining a Flowscripter CLI Command.

This is an extension of the esm-dynamic-plugins SubCommand.

Hierarchy

  • SubCommand
    • FlowscripterCommand

Index

Properties

Methods

Properties

Optional Readonly description

description: undefined | string

Optional description of the command.

Readonly name

name: string

Name of the command.

Must consist of alphanumeric non-whitespace ASCII characters or _ and - characters. Cannot start with -.

Readonly options

options: ReadonlyArray<Option>

Option arguments for the sub-command.

These will be used for invocation in the form of executable <sub_command_name> --<option_name>=<option_value>

Readonly positionals

positionals: ReadonlyArray<Positional>

Positional arguments for the sub-command.

These will be used for invocation in the form of executable <sub_command_name> <positional_value>

Optional Readonly topic

topic: undefined | string

Optional grouping topic of the command (to support output of CLI help).

Optional Readonly usageExamples

usageExamples: UsageExample[]

Optional usage examples for the command (to support output of CLI help).

Methods

run

  • run(commandArgs: CommandArgs, context: Context): Promise<void> | void

  • Run the command.

    Parameters

    • commandArgs: CommandArgs

      the arguments for the command.

    • context: Context

      the [[Context]] in which to run.

    Returns Promise<void> | void