read-vinyl-file-stream
Advanced tools
Comparing version 2.0.1 to 2.0.2
{ | ||
"name": "read-vinyl-file-stream", | ||
"version": "2.0.1", | ||
"version": "2.0.2", | ||
"main": "index.js", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -40,4 +40,4 @@ # read vinyl file stream | ||
- **iterator** _{Function}_ Required - the method that will process the files. | ||
- **flush** _{Function}_ Optional - the method to call before the stream ends. | ||
- **[iterator]** _{Function}_ Required - the method that will process the files. | ||
- **[flush]** _{Function}_ Optional - the method to call before the stream ends. | ||
- **encoding** _{String}_ Optional - the encoding to use for the content provided to the iterator function. By default, this is a UTF-8 string. The following options are supported: | ||
@@ -47,3 +47,4 @@ - `'utf8'` - provide the content in a UTF-8 string. | ||
### iterator(content, file, stream, cb) | ||
[iterator]: #iteratorcontent-file-stream-cb | ||
#### iterator(content, file, stream, cb) | ||
@@ -57,3 +58,4 @@ The function that you provide to it has the following parameters, in order: | ||
### flush(stream, cb) | ||
[flush]: #flushstream-cb | ||
#### flush(stream, cb) | ||
@@ -60,0 +62,0 @@ This is a function that will allow you to execute some code after all the files have been read but before the stream ends. It has the following parameters, in order: |
22465
136