overrun / index
Module: index
Table of contents
Classes
Interfaces
Type aliases
Functions
Type aliases
PathMapping
Ƭ PathMapping: (path: Path) => Path
Type declaration
▸ (path): Path
Parameters
| Name | Type |
|---|---|
path | Path |
Returns
Defined in
Path.ts:3
TransformFn
Ƭ TransformFn<In, Out>: (input: In) => Out
Type parameters
| Name |
|---|
In |
Out |
Type declaration
▸ (input): Out
Parameters
| Name | Type |
|---|---|
input | In |
Returns
Out
Defined in
TransformFnAsync
Ƭ TransformFnAsync<In, Out>: (input: In) => Promise<Out> | Out
Type parameters
| Name |
|---|
In |
Out |
Type declaration
▸ (input): Promise<Out> | Out
Parameters
| Name | Type |
|---|---|
input | In |
Returns
Promise<Out> | Out
Defined in
Functions
clearTargets
▸ clearTargets(): void
Remove all targets. Mainly used for testing.
Returns
void
Defined in
directory
▸ directory(baseOrPath, fragment?): DirectoryTask
Create a task which reads a source file and returns a buffer.
Parameters
| Name | Type |
|---|---|
baseOrPath | string | Path |
fragment? | string |
Returns
Defined in
output
▸ output(options?): (source: WritableTask) => OutputFileTask
Task generator function that generates an output task.
deprecated Prefer task.writeTo().
Parameters
| Name | Type |
|---|---|
options? | OutputOptions |
Returns
fn
▸ (source): OutputFileTask
Task generator function that generates an output task.
deprecated Prefer task.writeTo().
Parameters
| Name | Type |
|---|---|
source | WritableTask |
Returns
OutputFileTask
Defined in
▸ output(options?): (source: WritableTask[]) => OutputFileTask[]
Parameters
| Name | Type |
|---|---|
options? | OutputOptions |
Returns
fn
▸ (source): OutputFileTask[]
Parameters
| Name | Type |
|---|---|
source | WritableTask[] |
Returns
OutputFileTask[]
Defined in
▸ output(options?): (source: TaskArray<WritableTask>) => OutputFileTask[]
Parameters
| Name | Type |
|---|---|
options? | OutputOptions |
Returns
fn
▸ (source): OutputFileTask[]
Parameters
| Name | Type |
|---|---|
source | TaskArray<WritableTask> |
Returns
OutputFileTask[]
Defined in
source
▸ source(baseOrFile, fragment?): SourceFileTask
Create a task which reads a source file and returns a buffer.
Parameters
| Name | Type |
|---|---|
baseOrFile | string | Path |
fragment? | string |
Returns
Defined in
target
▸ target(builder): void
Parameters
| Name | Type |
|---|---|
builder | Builders |
Returns
void
Defined in
▸ target(name, builder): void
Parameters
| Name | Type |
|---|---|
name | string |
builder | Builders |
Returns
void