Conduitry/defiler
1
Fork 0
Code Activity

update docs for combined defiler.add method

Browse source
This commit is contained in:
Conduitry 2017-05-16 19:11:57 -04:00
parent e65600059d
commit f9ef6d1ca6
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
API.md
View file

@ -58,7 +58,7 @@ A sorted array of the relative paths of all of the physical files. This can be u
## Configuration
### `addGaze(gaze, rootPath, read = true)`
### `add({ gaze, rootPath, read = true })`
Register a Gaze instance.
@ -68,7 +68,7 @@ Register a Gaze instance.
Returns the `Defiler` instance for chaining.
### `addTransform(transform)`
### `add({ transform })`
Register a new transform to be applied to all files.
@ -84,9 +84,9 @@ Allows conditionally skipping certain transforms in the pipe.
Returns the `Defiler` instance for chaining.
This is used like: `defiler.if(file => someTest(file)).addTransform(onlyIfTrue).else().addTransform(onlyIfFalse).end()`.
This is used like: `defiler.if(file => someTest(file)).add({ transform: onlyIfTrue }).else().add({ transform: onlyIfFalse }).end()`.
### `addGeneratedFile(path, generator)`
### `add({ path, generator })`
Register a new generated file, not directly sourced from a physical file.