Interface TaskDefinition

Hierarchy

Properties

action addFlag addOptionalParam addOptionalPositionalParam addOptionalVariadicPositionalParam addParam addPositionalParam addVariadicPositionalParam description? isInternal name paramDefinitions positionalParamDefinitions setAction setDescription

Properties

Readonly action

action: ActionType<any>

addFlag

addFlag: ((name: string, description?: string) => TaskDefinition)

Type declaration

addOptionalParam

addOptionalParam: (<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>) => TaskDefinition)

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T
      • Optional type: ArgumentType<T>

      Returns TaskDefinition

addOptionalPositionalParam

addOptionalPositionalParam: (<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>) => TaskDefinition)

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T
      • Optional type: ArgumentType<T>

      Returns TaskDefinition

addOptionalVariadicPositionalParam

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T[]
      • Optional type: ArgumentType<T>

      Returns TaskDefinition

addParam

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T
      • Optional type: ArgumentType<T>
      • Optional isOptional: boolean

      Returns TaskDefinition

addPositionalParam

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T
      • Optional type: ArgumentType<T>
      • Optional isOptional: boolean

      Returns TaskDefinition

addVariadicPositionalParam

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      • name: string
      • Optional description: string
      • Optional defaultValue: T[]
      • Optional type: ArgumentType<T>
      • Optional isOptional: boolean

      Returns TaskDefinition

Optional Readonly description

description?: string

Readonly isInternal

isInternal: boolean

Readonly name

name: string

Readonly paramDefinitions

paramDefinitions: ParamDefinitionsMap

Readonly positionalParamDefinitions

positionalParamDefinitions: ParamDefinitionAny[]

setAction

setAction: ((action: ActionType<any>) => TaskDefinition)

Type declaration

setDescription

setDescription: ((description: string) => TaskDefinition)

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc