Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • Command
    • 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

Protected debug

debug: (...args: any[]) => void

Type declaration

    • (...args: any[]): void

    • Parameters

      • Rest ...args: any[]

      Returns void

id

id: undefined | string

Static _base

_base: string

Static aliases

aliases: string[]

An array of aliases for this command

Static Optional args

args: Input

An order-dependent array of arguments for the command

Static description

description: string = 'Single command that aggregates config, compose and run in one line!'

Static examples

examples: string[] = ...

Static flags

flags: { args: IOptionFlag<string[]>; assembly: IOptionFlag<undefined | string>; build: IBooleanFlag<boolean>; customPreset: IOptionFlag<undefined | string>; detached: IBooleanFlag<boolean>; healthCheck: IBooleanFlag<boolean>; help: IBooleanFlag<void>; logger: IOptionFlag<string>; noPassword: IBooleanFlag<boolean>; password: IOptionFlag<undefined | string>; preset: IOptionFlag<undefined | string>; pullImages: IBooleanFlag<boolean>; report: IBooleanFlag<boolean>; reset: IBooleanFlag<boolean>; resetData: IBooleanFlag<boolean>; target: IOptionFlag<string>; timeout: IOptionFlag<undefined | number>; upgrade: IBooleanFlag<boolean>; user: IOptionFlag<string> } = ...

Type declaration

  • args: IOptionFlag<string[]>
  • assembly: IOptionFlag<undefined | string>
  • build: IBooleanFlag<boolean>
  • customPreset: IOptionFlag<undefined | string>
  • detached: IBooleanFlag<boolean>
  • healthCheck: IBooleanFlag<boolean>
  • help: IBooleanFlag<void>
  • logger: IOptionFlag<string>
  • noPassword: IBooleanFlag<boolean>
  • password: IOptionFlag<undefined | string>
  • preset: IOptionFlag<undefined | string>
  • pullImages: IBooleanFlag<boolean>
  • report: IBooleanFlag<boolean>
  • reset: IBooleanFlag<boolean>
  • resetData: IBooleanFlag<boolean>
  • target: IOptionFlag<string>
  • timeout: IOptionFlag<undefined | number>
  • upgrade: IBooleanFlag<boolean>
  • user: IOptionFlag<string>

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>

instantiate and run the command

param

Class

param

argv

param

options

returns

Promise

Type declaration

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

    • Parameters

      • Optional argv: string[]
      • Optional config: LoadOptions

      Returns PromiseLike<any>

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

Protected _help

  • _help(): never

  • Returns never

Protected _helpOverride

  • _helpOverride(): boolean

  • Returns boolean

_run

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

  • Type parameters

    • T

    Returns Promise<undefined | T>

Protected _version

  • _version(): never

  • Returns never

Protected catch

  • catch(err: any): Promise<any>

  • Parameters

    • err: any

    Returns Promise<any>

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

Protected finally

  • finally(_: undefined | Error): Promise<any>

  • Parameters

    • _: undefined | Error

    Returns Promise<any>

Protected init

  • init(): Promise<any>

  • Returns Promise<any>

log

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

  • Parameters

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

    Returns void

Protected parse

  • parse<F, A>(options?: Input<F>, argv?: string[]): ParserOutput<F, A>

  • Type parameters

    • F

    • A: {}

    Parameters

    • Optional options: Input<F>
    • Optional argv: string[]

    Returns ParserOutput<F, A>

run

  • run(): Promise<void>

warn

  • warn(input: string | Error): void

  • Parameters

    • input: string | Error

    Returns void

Generated using TypeDoc