From 9c818e68e3e0124ca44ceeafeb4f7d1d934f1e49 Mon Sep 17 00:00:00 2001 From: contra Date: Sat, 6 Apr 2024 12:44:10 -0700 Subject: [PATCH] chore: update src.md docs to add encoding parameter --- docs/api/src.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/src.md b/docs/api/src.md index b6c69009a..ac28ec173 100644 --- a/docs/api/src.md +++ b/docs/api/src.md @@ -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
boolean | "utf8" | When false, file contents are treated as binary. When a string, this is used as the text encoding. | | buffer | boolean
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.
**Note:** Plugins may not implement support for streaming contents. | | read | boolean
function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. | | since | date
timestamp
function | | When set, only creates Vinyl objects for files modified since the specified time. |