You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/dest.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ dest(directory, [options])
32
32
33
33
| parameter | type | note |
34
34
|:--------------:|:-----:|--------|
35
-
| directory<br>**(required)**| string<br>function | The path of the output directory where files will be written. If a function is used, the function will be called with each Vinyl object and must return a string directory path. |
35
+
| directory<br>**(required)**| string<br>function | The path of the output directory where files will be written. If a function is used, the function will be called with each Vinyl object and must return a string directory path. |
36
36
| options | object | Detailed in [Options][options-section] below. |
37
37
38
38
### Returns
@@ -60,14 +60,14 @@ When `directory` is a function that returns an empty string or `undefined`, emit
60
60
61
61
| name | type | default | note |
62
62
|:-------:|:------:|-----------|-------|
63
-
| cwd | string<br>function |`process.cwd()`| The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `directory` with `path.join()`. |
64
-
| mode | number<br>function |`stat.mode` of the Vinyl object | The mode used when creating files. If not set and `stat.mode` is missing, the process' mode will be used instead. |
65
-
| dirMode | number<br>function || The mode used when creating directories. If not set, the process' mode will be used. |
66
-
| overwrite | boolean<br>function | true | When true, overwrites existing files with the same path. |
67
-
| append | boolean<br>function | false | If true, adds contents to the end of the file, instead of replacing existing contents. |
68
-
| sourcemaps | boolean<br>string<br>function | false | If true, writes inline sourcemaps to the output file. Specifying a `string` path will write external [sourcemaps][sourcemaps-section] at the given path. |
69
-
| relativeSymlinks | boolean<br>function | false | When false, any symbolic links created will be absolute.<br>**Note**: Ignored if a junction is being created, as they must be absolute. |
70
-
| useJunctions | boolean<br>function | true | This option is only relevant on Windows and ignored elsewhere. When true, creates directory symbolic link as a junction. Detailed in [Symbolic links on Windows][symbolic-links-section] below. |
63
+
| cwd | string<br>function |`process.cwd()`| The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `directory` with `path.join()`. |
64
+
| mode | number<br>function |`stat.mode` of the Vinyl object | The mode used when creating files. If not set and `stat.mode` is missing, the process' mode will be used instead. |
65
+
| dirMode | number<br>function || The mode used when creating directories. If not set, the process' mode will be used. |
66
+
| overwrite | boolean<br>function | true | When true, overwrites existing files with the same path. |
67
+
| append | boolean<br>function | false | If true, adds contents to the end of the file, instead of replacing existing contents. |
68
+
| sourcemaps | boolean<br>string<br>function | false | If true, writes inline sourcemaps to the output file. Specifying a `string` path will write external [sourcemaps][sourcemaps-section] at the given path. |
69
+
| relativeSymlinks | boolean<br>function | false | When false, any symbolic links created will be absolute.<br>**Note**: Ignored if a junction is being created, as they must be absolute. |
70
+
| useJunctions | boolean<br>function | true | This option is only relevant on Windows and ignored elsewhere. When true, creates directory symbolic link as a junction. Detailed in [Symbolic links on Windows][symbolic-links-section] below. |
Copy file name to clipboardExpand all lines: docs/api/parallel.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ parallel(...tasks)
37
37
38
38
| parameter | type | note |
39
39
|:--------------:|:------:|-------|
40
-
| tasks<br>**(required)**| function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
40
+
| tasks<br>**(required)**| function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
Copy file name to clipboardExpand all lines: docs/api/series.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ series(...tasks)
37
37
38
38
| parameter | type | note |
39
39
|:--------------:|:------:|-------|
40
-
| tasks<br>**(required)**| function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
40
+
| tasks<br>**(required)**| function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
Copy file name to clipboardExpand all lines: docs/api/src.md
+34-34Lines changed: 34 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ src(globs, [options])
35
35
36
36
| parameter | type | note |
37
37
|:--------------:|:------:|-------|
38
-
| globs | string<br>array |[Globs][globs-concepts] to watch on the file system. |
38
+
| globs | string<br>array |[Globs][globs-concepts] to watch on the file system. |
39
39
| options | object | Detailed in [Options][options-section] below. |
40
40
41
41
### Returns
@@ -55,39 +55,39 @@ When an invalid glob is given in `globs`, throws an error with the message, "Inv
55
55
56
56
| name | type | default | note |
57
57
|:--------:|:------:|------------|--------|
58
-
| buffer | boolean<br>function | true | When true, file contents are buffered into memory. If false, the Vinyl object's `contents` property will be a paused stream. It may not be possible to buffer the contents of large files.<br>**Note:** Plugins may not implement support for streaming contents. |
59
-
| read | boolean<br>function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. |
60
-
| since | date<br>timestamp<br>function || When set, only creates Vinyl objects for files modified since the specified time. |
61
-
| removeBOM | boolean<br>function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM. |
62
-
| sourcemaps | boolean<br>function | false | If true, enables [sourcemaps][sourcemaps-section] support on Vinyl objects created. Loads inline sourcemaps and resolves external sourcemap links. |
63
-
| resolveSymlinks | boolean<br>function | true | When true, recursively resolves symbolic links to their targets. If false, preserves the symbolic links and sets the Vinyl object's `symlink` property to the original file's path. |
64
-
| cwd | string |`process.cwd()`| The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `globs` with `path.join()`.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
65
-
| base | string || Explicitly set the `base` property on created Vinyl objects. Detailed in [API Concepts][glob-base-concepts].<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
66
-
| cwdbase | boolean | false | If true, `cwd` and `base` options should be aligned.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
67
-
| root | string || The root path that `globs` are resolved against.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
68
-
| allowEmpty | boolean | false | When false, `globs` which can only match one file (such as `foo/bar.js`) causes an error to be thrown if they don't find a match. If true, suppresses glob failures.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
69
-
| uniqueBy | string<br>function |`'path'`| Remove duplicates from the stream by comparing the string property name or the result of the function.<br>**Note:** When using a function, the function receives the streamed data (objects containing `cwd`, `base`, `path` properties). |
70
-
| dot | boolean | false | If true, compare globs against dot files, like `.gitignore`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
71
-
| silent | boolean | true | When true, suppresses warnings from printing on `stderr`.<br>**Note:** This option is passed directly to [node-glob][node-glob-external] but defaulted to `true` instead of `false`. |
72
-
| mark | boolean | false | If true, a `/` character will be appended to directory matches. Generally not needed because paths are normalized within the pipeline.<br>_This option is passed directly to [node-glob][node-glob-external]._|
73
-
| nosort | boolean | false | If true, disables sorting the glob results.<br>_This option is passed directly to [node-glob][node-glob-external]._|
74
-
| stat | boolean | false | If true, `fs.stat()` is called on all results. This adds extra overhead and generally should not be used.<br>_This option is passed directly to [node-glob][node-glob-external]._|
75
-
| strict | boolean | false | If true, an error will be thrown if an unexpected problem is encountered while attempting to read a directory.<br>_This option is passed directly to [node-glob][node-glob-external]._|
76
-
| nounique | boolean | false | When false, prevents duplicate files in the result set.<br>_This option is passed directly to [node-glob][node-glob-external]._|
77
-
| debug | boolean | false | If true, debugging information will be logged to the command line.<br>_This option is passed directly to [node-glob][node-glob-external]._|
78
-
| nobrace | boolean | false | If true, avoids expanding brace sets - e.g. `{a,b}` or `{1..3}`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
79
-
| noglobstar | boolean | false | If true, treats double-star glob character as single-star glob character.<br>_This option is passed directly to [node-glob][node-glob-external]._|
80
-
| noext | boolean | false | If true, avoids matching [extglob][extglob-docs] patterns - e.g. `+(ab)`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
81
-
| nocase | boolean | false | If true, performs a case-insensitive match.<br>**Note:** On case-insensitive file systems, non-magic patterns will match by default.<br>_This option is passed directly to [node-glob][node-glob-external]._|
82
-
| matchBase | boolean | false | If true and globs don't contain any `/` characters, traverses all directories and matches that glob - e.g. `*.js` would be treated as equivalent to `**/*.js`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
83
-
| nodir | boolean | false | If true, only matches files, not directories.<br>**Note:** To match only directories, end your glob with a `/`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
84
-
| ignore | string<br>array || Globs to exclude from matches. This option is combined with negated `globs`.<br>**Note:** These globs are always matched against dot files, regardless of any other settings.<br>_This option is passed directly to [node-glob][node-glob-external]._|
85
-
| follow | boolean | false | If true, symlinked directories will be traversed when expanding `**` globs.<br>**Note:** This can cause problems with cyclical links.<br>_This option is passed directly to [node-glob][node-glob-external]._|
86
-
| realpath | boolean | false | If true, `fs.realpath()` is called on all results. This may result in dangling links.<br>_This option is passed directly to [node-glob][node-glob-external]._|
87
-
| cache | object || A previously generated cache object - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
88
-
| statCache | object || A previously generated cache of `fs.Stat` results - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
89
-
| symlinks | object || A previously generated cache of symbolic links - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
90
-
| nocomment | boolean | false | When false, treat a `#` character at the start of a glob as a comment.<br>_This option is passed directly to [node-glob][node-glob-external]._|
58
+
| buffer | boolean<br>function | true | When true, file contents are buffered into memory. If false, the Vinyl object's `contents` property will be a paused stream. It may not be possible to buffer the contents of large files.<br>**Note:** Plugins may not implement support for streaming contents. |
59
+
| read | boolean<br>function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. |
60
+
| since | date<br>timestamp<br>function || When set, only creates Vinyl objects for files modified since the specified time. |
61
+
| removeBOM | boolean<br>function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM. |
62
+
| sourcemaps | boolean<br>function | false | If true, enables [sourcemaps][sourcemaps-section] support on Vinyl objects created. Loads inline sourcemaps and resolves external sourcemap links. |
63
+
| resolveSymlinks | boolean<br>function | true | When true, recursively resolves symbolic links to their targets. If false, preserves the symbolic links and sets the Vinyl object's `symlink` property to the original file's path. |
64
+
| cwd | string |`process.cwd()`| The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `globs` with `path.join()`.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
65
+
| base | string || Explicitly set the `base` property on created Vinyl objects. Detailed in [API Concepts][glob-base-concepts].<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
66
+
| cwdbase | boolean | false | If true, `cwd` and `base` options should be aligned.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
67
+
| root | string || The root path that `globs` are resolved against.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
68
+
| allowEmpty | boolean | false | When false, `globs` which can only match one file (such as `foo/bar.js`) causes an error to be thrown if they don't find a match. If true, suppresses glob failures.<br>_This option is passed directly to [glob-stream][glob-stream-external]._|
69
+
| uniqueBy | string<br>function |`'path'`| Remove duplicates from the stream by comparing the string property name or the result of the function.<br>**Note:** When using a function, the function receives the streamed data (objects containing `cwd`, `base`, `path` properties). |
70
+
| dot | boolean | false | If true, compare globs against dot files, like `.gitignore`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
71
+
| silent | boolean | true | When true, suppresses warnings from printing on `stderr`.<br>**Note:** This option is passed directly to [node-glob][node-glob-external] but defaulted to `true` instead of `false`. |
72
+
| mark | boolean | false | If true, a `/` character will be appended to directory matches. Generally not needed because paths are normalized within the pipeline.<br>_This option is passed directly to [node-glob][node-glob-external]._|
73
+
| nosort | boolean | false | If true, disables sorting the glob results.<br>_This option is passed directly to [node-glob][node-glob-external]._|
74
+
| stat | boolean | false | If true, `fs.stat()` is called on all results. This adds extra overhead and generally should not be used.<br>_This option is passed directly to [node-glob][node-glob-external]._|
75
+
| strict | boolean | false | If true, an error will be thrown if an unexpected problem is encountered while attempting to read a directory.<br>_This option is passed directly to [node-glob][node-glob-external]._|
76
+
| nounique | boolean | false | When false, prevents duplicate files in the result set.<br>_This option is passed directly to [node-glob][node-glob-external]._|
77
+
| debug | boolean | false | If true, debugging information will be logged to the command line.<br>_This option is passed directly to [node-glob][node-glob-external]._|
78
+
| nobrace | boolean | false | If true, avoids expanding brace sets - e.g. `{a,b}` or `{1..3}`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
79
+
| noglobstar | boolean | false | If true, treats double-star glob character as single-star glob character.<br>_This option is passed directly to [node-glob][node-glob-external]._|
80
+
| noext | boolean | false | If true, avoids matching [extglob][extglob-docs] patterns - e.g. `+(ab)`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
81
+
| nocase | boolean | false | If true, performs a case-insensitive match.<br>**Note:** On case-insensitive file systems, non-magic patterns will match by default.<br>_This option is passed directly to [node-glob][node-glob-external]._|
82
+
| matchBase | boolean | false | If true and globs don't contain any `/` characters, traverses all directories and matches that glob - e.g. `*.js` would be treated as equivalent to `**/*.js`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
83
+
| nodir | boolean | false | If true, only matches files, not directories.<br>**Note:** To match only directories, end your glob with a `/`.<br>_This option is passed directly to [node-glob][node-glob-external]._|
84
+
| ignore | string<br>array || Globs to exclude from matches. This option is combined with negated `globs`.<br>**Note:** These globs are always matched against dot files, regardless of any other settings.<br>_This option is passed directly to [node-glob][node-glob-external]._|
85
+
| follow | boolean | false | If true, symlinked directories will be traversed when expanding `**` globs.<br>**Note:** This can cause problems with cyclical links.<br>_This option is passed directly to [node-glob][node-glob-external]._|
86
+
| realpath | boolean | false | If true, `fs.realpath()` is called on all results. This may result in dangling links.<br>_This option is passed directly to [node-glob][node-glob-external]._|
87
+
| cache | object || A previously generated cache object - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
88
+
| statCache | object || A previously generated cache of `fs.Stat` results - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
89
+
| symlinks | object || A previously generated cache of symbolic links - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._|
90
+
| nocomment | boolean | false | When false, treat a `#` character at the start of a glob as a comment.<br>_This option is passed directly to [node-glob][node-glob-external]._|
0 commit comments