Skip to content

Commit

Permalink
Merge pull request gulpjs#647 from briandipalma/gulp.dest-doc
Browse files Browse the repository at this point in the history
Create missing `gulp.dest` parameter docs.
  • Loading branch information
yocontra committed Aug 30, 2014
2 parents ee37f90 + 4b61214 commit 30e996f
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Default: `true`

Setting this to `false` will return `file.contents` as null and not read the file at all.

### gulp.dest(path)
### gulp.dest(path[, options])

Can be piped to and it will write files. Re-emits all data passed to it so you can pipe to multiple folders. Folders that don't exist will be created.

Expand All @@ -50,9 +50,24 @@ gulp.src('./client/templates/*.jade')
```

#### path
Type: `String` or `Function`

The path (output folder) to write files to. Or a function that returns it, the function will be provided a [vinyl File instance](https://github.com/wearefractal/vinyl).

#### options
Type: `Object`

#### options.cwd
Type: `String`
Default: `process.cwd()`

`cwd` for the output folder, only has an effect if provided output folder is relative.

#### options.mode
Type: `String`
Default: `0777`

The path (folder) to write files to.
Octal permission string specifying mode for any folders that need to be created for output folder.

### gulp.task(name[, deps], fn)

Expand Down

0 comments on commit 30e996f

Please sign in to comment.