summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/block-stream/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/block-stream/README.md')
-rw-r--r--deps/npm/node_modules/block-stream/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/deps/npm/node_modules/block-stream/README.md b/deps/npm/node_modules/block-stream/README.md
new file mode 100644
index 0000000000..c16e9c4688
--- /dev/null
+++ b/deps/npm/node_modules/block-stream/README.md
@@ -0,0 +1,14 @@
+# block-stream
+
+A stream of blocks.
+
+Write data into it, and it'll output data in buffer blocks the size you
+specify, padding with zeroes if necessary.
+
+```javascript
+var block = new BlockStream(512)
+fs.createReadStream("some-file").pipe(block)
+block.pipe(fs.createWriteStream("block-file"))
+```
+
+When `.end()` or `.flush()` is called, it'll pad the block with zeroes.