overrun / index / DirectoryTask
Class: DirectoryTask
index.DirectoryTask
A task which reads the contents of a directory.
Hierarchy
-
AbstractTask<Path[]>↳
DirectoryTask
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new DirectoryTask(path)
Parameters
| Name | Type |
|---|---|
path | Path |
Overrides
Defined in
Properties
path
• Readonly path: Path
The filesystem location associated with the build artifact produced by this task.
Inherited from
Methods
addDependent
▸ 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
Overrides
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
Inherited from
Defined in
files
▸ files(): TaskArray<SourceFileTask>
Create a task for every file in the directory.
Returns
Defined in
match
▸ match(pattern): TaskArray<SourceFileTask>
Create a task for every file that matches the glob.
Parameters
| Name | Type |
|---|---|
pattern | string |
Returns
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: DirectoryTask) => Dependant |
Returns
Dependant
Inherited from
Defined in
read
▸ read(): Promise<Path[]>
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<Path[]>
Overrides
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: Path[]) => Out | Promise<Out> |
Returns
Task<Out>