Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TaskDefinition

Hierarchy

Index

Properties

Methods

Properties

Readonly action

action: ActionType<any>

Optional Readonly description

description?: string

Readonly isInternal

isInternal: boolean

Readonly name

name: string

Readonly paramDefinitions

paramDefinitions: ParamDefinitionsMap

Readonly positionalParamDefinitions

positionalParamDefinitions: ParamDefinitionAny[]

Methods

addFlag

  • addFlag(name: string, description?: string): this

addOptionalParam

  • addOptionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>): this

addOptionalPositionalParam

  • addOptionalPositionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>): this

addOptionalVariadicPositionalParam

  • addOptionalVariadicPositionalParam<T>(name: string, description?: string, defaultValue?: T[], type?: ArgumentType<T>): this

addParam

  • addParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>, isOptional?: boolean): this

addPositionalParam

  • addPositionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>, isOptional?: boolean): this

addVariadicPositionalParam

  • addVariadicPositionalParam<T>(name: string, description?: string, defaultValue?: T[], type?: ArgumentType<T>, isOptional?: boolean): this

setAction

setDescription

  • setDescription(description: string): this

Generated using TypeDoc