@nomiclabs/buidler > OverriddenTaskDefinition

# Class: OverriddenTaskDefinition

# Hierarchy

OverriddenTaskDefinition

# Implements

# Index

# Constructors

# Properties

# Accessors

# Methods


# Constructors

# constructor

new OverriddenTaskDefinition(parentTaskDefinition: TaskDefinition, isInternal?: boolean): OverriddenTaskDefinition

Defined in internal/core/tasks/task-definitions.ts:527

Parameters:

Name Type Default value
parentTaskDefinition TaskDefinition -
Default value isInternal boolean false

Returns: OverriddenTaskDefinition


# Properties

# isInternal

● isInternal: boolean

Implementation of TaskDefinition.isInternal

Defined in internal/core/tasks/task-definitions.ts:531


# parentTaskDefinition

● parentTaskDefinition: TaskDefinition

Defined in internal/core/tasks/task-definitions.ts:530


# Accessors

# action

action:

Implementation of TaskDefinition.action

Defined in internal/core/tasks/task-definitions.ts:575


# description

description:

Implementation of TaskDefinition.description

Defined in internal/core/tasks/task-definitions.ts:563


# name

name:

Implementation of TaskDefinition.name

Defined in internal/core/tasks/task-definitions.ts:555


# paramDefinitions

paramDefinitions:

Implementation of TaskDefinition.paramDefinitions

Defined in internal/core/tasks/task-definitions.ts:586


# positionalParamDefinitions

positionalParamDefinitions:

Implementation of TaskDefinition.positionalParamDefinitions

Defined in internal/core/tasks/task-definitions.ts:593


# Methods

# addFlag

addFlag(name: string, description: undefined | string): this

Implementation of TaskDefinition.addFlag

Defined in internal/core/tasks/task-definitions.ts:696

Parameters:

Name Type
name string
Optional description undefined | string

Returns: this


# addOptionalParam

addOptionalParam<T>(name: string, description: undefined | string, defaultValue: T, type: types.ArgumentType<T>): this

Implementation of TaskDefinition.addOptionalParam

Defined in internal/core/tasks/task-definitions.ts:618

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T
Optional type types.ArgumentType<T>

Returns: this


# addOptionalPositionalParam

addOptionalPositionalParam<T>(name: string, description: undefined | string, defaultValue: T, type: types.ArgumentType<T>): this

Implementation of TaskDefinition.addOptionalPositionalParam

Defined in internal/core/tasks/task-definitions.ts:651

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T
Optional type types.ArgumentType<T>

Returns: this


# addOptionalVariadicPositionalParam

addOptionalVariadicPositionalParam<T>(name: string, description: undefined | string, defaultValue: T[], type: types.ArgumentType<T>): this

Implementation of TaskDefinition.addOptionalVariadicPositionalParam

Defined in internal/core/tasks/task-definitions.ts:680

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T[]
Optional type types.ArgumentType<T>

Returns: this


# addParam

addParam<T>(name: string, description: undefined | string, defaultValue: T, type: types.ArgumentType<T>, isOptional: undefined | false | true): this

Implementation of TaskDefinition.addParam

Defined in internal/core/tasks/task-definitions.ts:600

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T
Optional type types.ArgumentType<T>
Optional isOptional undefined | false | true

Returns: this


# addPositionalParam

addPositionalParam<T>(name: string, description: undefined | string, defaultValue: T, type: types.ArgumentType<T>, isOptional: undefined | false | true): this

Implementation of TaskDefinition.addPositionalParam

Defined in internal/core/tasks/task-definitions.ts:636

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T
Optional type types.ArgumentType<T>
Optional isOptional undefined | false | true

Returns: this


# addVariadicPositionalParam

addVariadicPositionalParam<T>(name: string, description: undefined | string, defaultValue: T[], type: types.ArgumentType<T>, isOptional: undefined | false | true): this

Implementation of TaskDefinition.addVariadicPositionalParam

Defined in internal/core/tasks/task-definitions.ts:665

Type parameters:

# T

Parameters:

Name Type
name string
Optional description undefined | string
Optional defaultValue T[]
Optional type types.ArgumentType<T>
Optional isOptional undefined | false | true

Returns: this


# setAction

setAction<ArgsT>(action: ActionType<ArgsT>): this

Implementation of TaskDefinition.setAction

Defined in internal/core/tasks/task-definitions.ts:546

Type parameters:

# ArgsT : TaskArguments

Parameters:

Name Type Description
action ActionType<ArgsT> the action.

Returns: this


# setDescription

setDescription(description: string): this

Implementation of TaskDefinition.setDescription

Defined in internal/core/tasks/task-definitions.ts:537

Parameters:

Name Type
description string

Returns: this