@nomiclabs/buidler > TasksDSL

Class: TasksDSL

This class defines the DSL used in Buidler config files for creating and overriding tasks.

Hierarchy

TasksDSL

Index

Methods


Methods

getTaskDefinitions

getTaskDefinitions(): TasksMap

Defined in internal/core/tasks/dsl.ts:105

Retrieves the task definitions.

Returns: TasksMap The tasks container.


internalTask

internalTask<ArgsT>(name: string, description?: undefined | string, action?: ActionType<ArgsT>): TaskDefinition

internalTask<ArgsT>(name: string, action: ActionType<ArgsT>): TaskDefinition

Defined in internal/core/tasks/dsl.ts:71

Creates an internal task, overrdining any previous task with the same name.

remarks: The internal tasks won't be displayed in the CLI help messages.

remarks: The action must await every async call made within it.

Type parameters:

ArgsT : TaskArguments

Parameters:

Name Type Description
name string The task's name.
Optional description undefined | string The task's description.
Optional action ActionType<ArgsT> The task's action.

Returns: TaskDefinition A task definition.

Defined in internal/core/tasks/dsl.ts:88

Creates an internal task without description, overrdining any previous task with the same name.

remarks: The internal tasks won't be displayed in the CLI help messages.

remarks: The action must await every async call made within it.

Type parameters:

ArgsT : TaskArguments

Parameters:

Name Type Description
name string The task's name.
action ActionType<ArgsT> The task's action.

Returns: TaskDefinition A task definition.


task

task<ArgsT>(name: string, description?: undefined | string, action?: ActionType<ArgsT>): TaskDefinition

task<ArgsT>(name: string, action: ActionType<ArgsT>): TaskDefinition

Defined in internal/core/tasks/dsl.ts:30

Creates a task, overrdining any previous task with the same name.

remarks: The action must await every async call made within it.

Type parameters:

ArgsT : TaskArguments

Parameters:

Name Type Description
name string The task's name.
Optional description undefined | string The task's description.
Optional action ActionType<ArgsT> The task's action.

Returns: TaskDefinition A task definition.

Defined in internal/core/tasks/dsl.ts:47

Creates a task without description, overrdining any previous task with the same name.

remarks: The action must await every async call made within it.

Type parameters:

ArgsT : TaskArguments

Parameters:

Name Type Description
name string The task's name.
action ActionType<ArgsT> The task's action.

Returns: TaskDefinition A task definition.