@nomiclabs/buidler > TaskDefinition

Interface: TaskDefinition

Hierarchy

ConfigurableTaskDefinition

↳ TaskDefinition

Implemented by

Index

Properties

Methods


Properties

action

● action: ActionType<TaskArguments>

Defined in types.ts:241


<Optional> description

● description: undefined | string

Defined in types.ts:240


isInternal

● isInternal: boolean

Defined in types.ts:242


name

● name: string

Defined in types.ts:239


paramDefinitions

● paramDefinitions: ParamDefinitionsMap

Defined in types.ts:246


positionalParamDefinitions

● positionalParamDefinitions: Array<ParamDefinition<any>>

Defined in types.ts:248


Methods

addFlag

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

Inherited from ConfigurableTaskDefinition.addFlag

Defined in types.ts:190

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

Inherited from ConfigurableTaskDefinition.addOptionalParam

Defined in types.ts:153

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

Inherited from ConfigurableTaskDefinition.addOptionalPositionalParam

Defined in types.ts:168

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

Inherited from ConfigurableTaskDefinition.addOptionalVariadicPositionalParam

Defined in types.ts:183

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

Inherited from ConfigurableTaskDefinition.addParam

Defined in types.ts:145

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

Inherited from ConfigurableTaskDefinition.addPositionalParam

Defined in types.ts:160

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

Inherited from ConfigurableTaskDefinition.addVariadicPositionalParam

Defined in types.ts:175

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(action: ActionType<TaskArguments>): this

Inherited from ConfigurableTaskDefinition.setAction

Defined in types.ts:143

Parameters:

Name Type
action ActionType<TaskArguments>

Returns: this


setDescription

setDescription(description: string): this

Inherited from ConfigurableTaskDefinition.setDescription

Defined in types.ts:141

Parameters:

Name Type
description string

Returns: this