Skip to content

Commit

Permalink
chore: update src.md docs to add encoding parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
yocontra committed Apr 6, 2024
1 parent 5c4c547 commit 9c818e6
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/src.md
Expand Up @@ -55,6 +55,7 @@ When an invalid glob is given in `globs`, throws an error with the message, "Inv

| name | type | default | note |
|:--------:|:------:|------------|--------|
| encoding | string<br />boolean | "utf8" | When false, file contents are treated as binary. When a string, this is used as the text encoding. |
| 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. |
| 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()`. |
| since | date<br />timestamp<br />function | | When set, only creates Vinyl objects for files modified since the specified time. |
Expand Down

0 comments on commit 9c818e6

Please sign in to comment.