Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new default(argv: string[], config: IConfig): default

  • Parameters

    • argv: string[]
    • config: IConfig

    Returns default

Properties

argv

argv: string[]

config

config: IConfig

id

id: undefined | string

Static _base

_base: string

Static aliases

aliases: string[]

An array of aliases for this command

Static args

args: { name: string; required: boolean }[] = ...

Static description

description: string = ...

Static examples

examples: string[] = ...

Static flags

flags: { basePath: IOptionFlag<string>; height: IOptionFlag<number>; help: IBooleanFlag<void>; output: IOptionFlag<undefined | string>; verbose: IBooleanFlag<boolean>; viewer: IBooleanFlag<boolean>; width: IOptionFlag<number> } = ...

Type declaration

  • basePath: IOptionFlag<string>
  • height: IOptionFlag<number>
  • help: IBooleanFlag<void>
  • output: IOptionFlag<undefined | string>
  • verbose: IBooleanFlag<boolean>
  • viewer: IBooleanFlag<boolean>
  • width: IOptionFlag<number>

Static help

help: undefined | string

Static hidden

hidden: boolean

hide the command from help?

Static id

id: string

A command ID, used mostly in error or verbose reporting

Static parse

parse: boolean

Static parserOptions

parserOptions: {}

Type declaration

    Static plugin

    plugin: undefined | IPlugin

    Static run

    run: (argv?: string[], config?: LoadOptions) => PromiseLike<any>

    Type declaration

      • (argv?: string[], config?: LoadOptions): PromiseLike<any>

      • instantiate and run the command

        Parameters

        • Optional argv: string[]

          argv

        • Optional config: LoadOptions

        Returns PromiseLike<any>

        Promise

    Static strict

    strict: boolean

    When set to false, allows a variable amount of arguments

    Static title

    title: undefined | string

    Static usage

    usage: undefined | string | string[]

    An override string (or strings) for the default usage documentation

    Accessors

    ctor

    • get ctor(): typeof default

    • Returns typeof default

    Methods

    _run

    • _run<T>(): Promise<undefined | T>

    • Type parameters

      • T

      Returns Promise<undefined | T>

    error

    • error(input: string | Error, options: { code?: string; exit: false } & PrettyPrintableError): void
    • error(input: string | Error, options?: { code?: string; exit?: number } & PrettyPrintableError): never

    • Parameters

      • input: string | Error
      • options: { code?: string; exit: false } & PrettyPrintableError

      Returns void

    • Parameters

      • input: string | Error
      • Optional options: { code?: string; exit?: number } & PrettyPrintableError

      Returns never

    exit

    • exit(code?: number): never

    • Parameters

      • Optional code: number

      Returns never

    init

    • init(): Promise<void>

    log

    • log(message?: string, ...args: any[]): void

    • Parameters

      • Optional message: string
      • Rest ...args: any[]

      Returns void

    run

    • run(): Promise<void>

    warn

    • warn(input: string | Error): void

    • Parameters

      • input: string | Error

      Returns void