overrun / index / AbstractTask
Class: AbstractTask<T>
index.AbstractTask
An abstract base class useful for defining custom tasks. It implements most of the methods of the Task interface.
Type parameters
| Name |
|---|
T |
Hierarchy
-
AbstractTask
Implements
Task<T>
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new AbstractTask<T>()
Type parameters
| Name |
|---|
T |
Properties
path
• Readonly Abstract path: Path
The filesystem location associated with the build artifact produced by this task.
Implementation of
Defined in
Methods
addDependent
▸ Abstract addDependent(dependent, dependencies): void
Mark a task as being dependent on this task, meaning that the target is considered to be out of date when any of its dependencies are out of date.
Parameters
| Name | Type |
|---|---|
dependent | Task<unknown> |
dependencies | Set<SourceTask> |
Returns
void
Implementation of
Defined in
dest
▸ dest(baseOrPath, fragment?): OutputFileTask
Create an output task that writes to a specified location. This method is only valid if the output type of the task is a string or Buffer object.
Examples:
path.dest(newPath);
path.dest(newBase, null);
path.dest(null, newFragment);
path.dest(path => path.withBase(newBase));
Parameters
| Name | Type |
|---|---|
baseOrPath | null | string | Path | PathMapping |
fragment? | null | string |
Returns
OutputFileTask
Implementation of
Defined in
pipe
▸ pipe<Out, Dependant>(taskGen): Dependant
Pipe the output of this task through another task. Similar to transform(), except that it allows more flexibility in processing.
Type parameters
| Name | Type |
|---|---|
Out | Out |
Dependant | extends Task<Out, Dependant> |
Parameters
| Name | Type |
|---|---|
taskGen | (input: AbstractTask<T>) => Dependant |
Returns
Dependant
Implementation of
Defined in
read
▸ Abstract read(): Promise<T>
Returns a Promise that resolves to the data output by this task. This is generally called by pipeline operators to read the data from the previous step, however operators are not required to do this.
Returns
Promise<T>
Implementation of
Defined in
transform
▸ transform<Out>(transform): Task<Out>
Creates a new task which transforms the output of this task’s data. The transform argument is a function which accepts the task’s output as an argument, and which returns either the transformed data or a promise which resolves to that data.
The task created will list the current task as a dependency, so if the source file is changed the transform task will be re-run.
Type parameters
| Name |
|---|
Out |
Parameters
| Name | Type |
|---|---|
transform | (input: T) => Out | Promise<Out> |
Returns
Task<Out>