Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CommandModule<T, U>

Type parameters

  • T

  • U

Hierarchy

  • CommandModule

Index

Properties

Optional aliases

aliases: ReadonlyArray<string> | string

array of strings (or a single string) representing aliases of exports.command, positional args defined in an alias are ignored

Optional builder

builder: CommandBuilder<T, U>

object declaring the options the command accepts, or a function accepting and returning a yargs instance

Optional command

command: ReadonlyArray<string> | string

string (or array of strings) that executes this command when given on the command line, first string may contain positional args

Optional describe

describe: string | false

string used as the description for the command in help text, use false for a hidden command

handler

handler: (args: Arguments<U>) => void

a function which will be passed the parsed argv.

Type declaration