Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CLI

Create a new Actionhero CLI Command. The required properties of an CLI command. These can be defined statically (this.name) or as methods which return a value.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CLI(): CLI

Properties

description

description: string

The description of the CLI command (default this.name)

example

example: string

An example of how to run this CLI command

inputs

inputs: {}

The inputs of the CLI command (default: {})

Type declaration

  • [key: string]: any

name

name: string

The name of the CLI command.

Methods

Private getDefaults

  • getDefaults(): { description: string; example: string; inputs: {}; name: null }

  • Returns { description: string; example: string; inputs: {}; name: null }

    • description: string
    • example: string
    • inputs: {}
    • name: null

Abstract run

  • run(data: {}): Promise<boolean>

  • The main "do something" method for this CLI command. It is an async method. If error is thrown in this method, it will be logged to STDERR, and the process will terminate with a non-0 exit code.

    Parameters

    • data: {}
      • [key: string]: any

    Returns Promise<boolean>

validate

  • validate(): void

Generated using TypeDoc