{"_id":"buffer-peek-stream","_rev":"20-c802335d4517a1f3bccd787cd97f81f5","name":"buffer-peek-stream","time":{"modified":"2022-06-13T05:15:25.044Z","created":"2014-11-05T23:08:11.528Z","0.1.0":"2014-11-05T23:08:11.528Z","0.1.1":"2014-11-05T23:14:40.596Z","0.1.2":"2014-11-07T15:14:11.578Z","0.1.3":"2014-11-11T20:38:17.961Z","0.2.0":"2014-11-13T21:00:26.332Z","1.0.0":"2015-05-19T22:20:34.515Z","1.0.1":"2015-06-09T14:18:20.954Z","1.1.0":"2020-02-02T15:26:47.288Z"},"maintainers":[{"email":"davidgwking@gmail.com","name":"davidgwking"},{"email":"seanlgarner@gmail.com","name":"seangarner"}],"dist-tags":{"latest":"1.1.0"},"description":"Transform stream that lets you inspect the start of a readable stream before deciding what to do with it","readme":"# node-buffer-peek-stream\n\n[![Build Status](https://travis-ci.org/seangarner/node-buffer-peek-stream.svg?branch=master)](https://travis-ci.org/seangarner/node-buffer-peek-stream)\n\nTake a peek at the start of a stream and get back a new stream rewound from the start without\nbuffering the entire stream.  Useful when you need to inspect the start of the stream before\ndeciding what to do with the stream.\n\n```\nnpm install buffer-peek-stream\n```\n\nUseful if you want to inspect the start of a stream before deciding what to do with it.\n\nThis works with buffers and does no string decoding.  If you know you have a string and already\nknow its encoding then checkout [peek-stream](https://github.com/mafintosh/peek-stream).\n\n\n## Usage\nAs a promise (with await)...\n```\nconst peek = require('buffer-peek-stream').promise;\nconst readstream = fs.createReadStream('package.json');\n\nconst [data, outputStream] = await peek(readstream, 65536);\n\n// outputStream is ready to be piped somewhere else\noutputStream.pipe(somewhere_else);\n```\n\nAs a callback...\n```\nvar peek = require('buffer-peek-stream');\nvar readstream = fs.createReadStream('package.json');\n\npeek(readstream, 65536, function (err, data, outputStream) {\n  if (err) throw err;\n\n  // outputStream is ready to be piped somewhere else\n  outputStream.pipe(somewhere_else);\n});\n```\n\nAs a stream...\n```\nvar PeekStream = require('buffer-peek-stream').BufferPeekStream;\n\nvar peek = new PeekStream(65536);\nvar readstream = fs.createReadStream('package.json');\n\n// peek will only emit the peek event once\npeek.once('peek', function (buf) {\n\n  // readstream is ready to be piped somewhere else\n  peek.pipe(somewhere_else);\n});\n\nreadstream.pipe(peek);\n\n// alternatively pipe `peek` here instead of in `data` callback\n```\n\n\n## Licence\nMIT\n","versions":{"0.1.1":{"name":"buffer-peek-stream","version":"0.1.1","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"lib/index.js","scripts":{"test":"mocha test/buffer-peek-stream.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","gitHead":"e0d3bdee4079c8fae5a85aa93aeded2ff5a15541","_id":"buffer-peek-stream@0.1.1","_shasum":"7febaf398d5696be132d26ccbd31a40f8b04fd52","_from":".","_npmVersion":"1.4.21","_npmUser":{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"}],"dist":{"shasum":"7febaf398d5696be132d26ccbd31a40f8b04fd52","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-0.1.1.tgz","integrity":"sha512-0g4T+YjN6+clPYtyLEHIYjLMuxW/L8oVLDCrhlvTqWDREBhzpLazAcxpeArT5X1N1D1oWqyG28SLNuCiQ83pEA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCZDhTwBbJNQ7tRmQBWhUwNZcuGb7DsZQfHaIkQy6yc4wIgW7jguP5rpta4I1xmC/QaMp2XO8C6WmYAJgzzOtPs0vY="}]},"directories":{}},"0.1.2":{"name":"buffer-peek-stream","version":"0.1.2","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"lib/index.js","scripts":{"test":"mocha test/buffer-peek-stream.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","gitHead":"99fc7d4c30edd5a10501f76d888cd08e62e88a6b","_id":"buffer-peek-stream@0.1.2","_shasum":"58099e76309719a74bbfb8f5ee81faaa1f67d047","_from":".","_npmVersion":"1.4.21","_npmUser":{"name":"seangarner","email":"seanlgarner@gmail.com"},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},{"name":"davidgwking","email":"davidgwking@gmail.com"}],"dist":{"shasum":"58099e76309719a74bbfb8f5ee81faaa1f67d047","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-0.1.2.tgz","integrity":"sha512-IdGTI9yCcoCh3PkbXU3ndL99oSCYOlX+dHHZu+/5zL2P/q49fg+DWmHwk8WtfDdr5I9dd9jgZ6lKVGhm5I+wVg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCe5AWgcysWe5cMx8PA0is6WZ9DZ1tHqoIxgzbs+hmxuAIhAK+33xK8VHnYMtK1o0NyWCQdh/5W4Hnx9tjUeMFRxdKI"}]},"directories":{}},"0.1.3":{"name":"buffer-peek-stream","version":"0.1.3","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"lib/index.js","scripts":{"test":"mocha test.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","devDependencies":{"chai":"^1.9.2","mocha":"^2.0.1","randomstring":"^1.0.3"},"gitHead":"543a8acafdea7a8de20981ef69be1a0857d0f49f","_id":"buffer-peek-stream@0.1.3","_shasum":"2644004b419087056b95dc200f1e74200951316c","_from":".","_npmVersion":"1.4.21","_npmUser":{"name":"seangarner","email":"seanlgarner@gmail.com"},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},{"name":"davidgwking","email":"davidgwking@gmail.com"}],"dist":{"shasum":"2644004b419087056b95dc200f1e74200951316c","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-0.1.3.tgz","integrity":"sha512-x8+NUzFgUUFEe8rsfvpPojNqE0vmKZaBl8LlWU+LrF2P2XxVpeQIoRWHlL5NZ/JB6dRFnPYvzBJOL2poLP3h2g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDN+oAQC2asWrJv2d+bJ5ppwVBBCZ2kiHf4NgRZTNlkMAIgMic5n2TbN9b7IgH5RvY75X7Vsp1AriWPH4/AOCtlHHA="}]},"directories":{}},"0.2.0":{"name":"buffer-peek-stream","version":"0.2.0","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"buffer-peek-stream.js","scripts":{"test":"node_modules/mocha/bin/mocha test.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","streams","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","devDependencies":{"chai":"^1.10.0","concat-stream":"^1.4.6","dev-null-stream":"0.0.1","mocha":"^2.0.1","randstream":"^0.3.2","truncate-stream":"^1.0.1"},"gitHead":"424b0a96c99e1b096518b181e4df1bc92ef0c93f","_id":"buffer-peek-stream@0.2.0","_shasum":"a2d04a5f510132f4032932c1ca6c95dfef55dc1b","_from":".","_npmVersion":"1.4.21","_npmUser":{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},{"name":"davidgwking","email":"davidgwking@gmail.com"}],"dist":{"shasum":"a2d04a5f510132f4032932c1ca6c95dfef55dc1b","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-0.2.0.tgz","integrity":"sha512-7G8ZaZ8378r3tsGNqum+QEMIpA8cu/kUW1lFID+DmnBZC8gVvQOIl6ujaNtVxyeQrmjCkUXsvwIFkjbyJ85Wag==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICx1jYs203U9tBH3dGMZCsfYCikWGALtozrgtnglxh3uAiABa8yYwnGKF2X2dXsyOKDbK5/ngC2fBJB1xWqXkQ5/2w=="}]},"directories":{}},"1.0.0":{"name":"buffer-peek-stream","version":"1.0.0","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"buffer-peek-stream.js","scripts":{"test":"node_modules/mocha/bin/mocha test.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","streams","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","devDependencies":{"chai":"^1.10.0","concat-stream":"^1.4.6","dev-null-stream":"0.0.1","mocha":"^2.0.1","randstream":"^0.3.2","truncate-stream":"^1.0.1"},"gitHead":"4ef20fde6143b94a8a1a40823994cc7476675c06","_id":"buffer-peek-stream@1.0.0","_shasum":"8054677127ddfef74e8733cfd62d594ecede8afd","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"seangarner","email":"seanlgarner@gmail.com"},"dist":{"shasum":"8054677127ddfef74e8733cfd62d594ecede8afd","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-1.0.0.tgz","integrity":"sha512-N/urmF93lEGjcWE15i/DD0Ry2VonOA4yy7bQf8FQhmYDbjM25I4ZF7F0pfsGxJv9yWcd4Q4GSglL7DuvA6Kz5A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCsxQfXTKNcQiryfwmIN7AgI8VhovggV0eh3WrWEFMV9QIgSAMgkBAlorh+PhFc2a67VQ5AKzlA370pu3E0yp1P9nQ="}]},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},{"name":"davidgwking","email":"davidgwking@gmail.com"}],"directories":{}},"1.0.1":{"name":"buffer-peek-stream","version":"1.0.1","description":"Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","main":"buffer-peek-stream.js","scripts":{"test":"node_modules/mocha/bin/mocha test.js"},"repository":{"type":"git","url":"https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","streams","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","devDependencies":{"chai":"^1.10.0","concat-stream":"^1.4.6","dev-null-stream":"0.0.1","mocha":"^2.0.1","randstream":"^0.3.2","truncate-stream":"^1.0.1"},"gitHead":"9c2c883def2771bb68920f9d7e43da13f617e23f","_id":"buffer-peek-stream@1.0.1","_shasum":"53b47570a1347787c5bad4ca2ca3021f9d8b3cfd","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"seangarner","email":"seanlgarner@gmail.com"},"dist":{"shasum":"53b47570a1347787c5bad4ca2ca3021f9d8b3cfd","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-1.0.1.tgz","integrity":"sha512-xVBjLJYyro9fHw/tiindgP66ye1A2XAgZGd7BIVvP8WVoSvMCL4xPJjyyznkCMIIf3pNQo+gKwYvDCfjZFJ5cQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD2nT+x5+XEL/ij7gWgJanT6BR5YDdWLUAYHBpzJrMHdwIhAIiDhsJ/efKZK1cFg0j7K0M8cPHmtM1zfoNwSKJBLbT/"}]},"maintainers":[{"name":"seangarner","email":"seanlgarner+npm@gmail.com"},{"name":"davidgwking","email":"davidgwking@gmail.com"}],"directories":{}},"1.1.0":{"name":"buffer-peek-stream","version":"1.1.0","description":"Transform stream that lets you inspect the start of a readable stream before deciding what to do with it","main":"buffer-peek-stream.js","scripts":{"test":"node_modules/mocha/bin/mocha test.js"},"repository":{"type":"git","url":"git+https://github.com/seangarner/node-buffer-peek-stream.git"},"keywords":["stream","streams","peek","parse","buffer","inspect"],"author":{"name":"Sean Garner"},"license":"MIT","bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","devDependencies":{"chai":"^4.2.0","concat-stream":"^1.4.6","dev-null-stream":"0.0.1","mocha":"^6.2.1","randstream":"^0.3.2","truncate-stream":"^1.0.1"},"gitHead":"faf3530cc66299b41f600efa03a37b472a0a8019","_id":"buffer-peek-stream@1.1.0","_nodeVersion":"12.13.1","_npmVersion":"6.12.1","dist":{"integrity":"sha512-b3MXlJ52rPOL5xCAQsiCOy/tY9WXOP/hwATporJriUDxnT3MjJgVppDzTFegpg2Nw7NMS28MKC6IKvaXLnGr+Q==","shasum":"4d0c3605274e1af479a2654b9b9674458897cd86","tarball":"https://registry.npmjs.org/buffer-peek-stream/-/buffer-peek-stream-1.1.0.tgz","fileCount":7,"unpackedSize":10360,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNuo3CRA9TVsSAnZWagAAjIAP+gLCbVm9UwyoAzxDrTW9\ng2TOiIaIJ7n9h6PJwL5vgUu/jN075YrPOSyaEBpOce1lxo9Zyv0Yvxb5wzJ8\nKqMETP08FBWvWw8W6n7oLNn4PBxkKUbRuY+x+8KnJLpIMthbGPHCeHbYGbET\nJVG/taFrbG4z8Oln3/hvjCutX93yd0Frx/Ul7YedgNMZNymE3vzsSsYct8H8\nBOqnffSmJX82TXmn9WEe/6XVcKpmxyK8HT2WrqgVJv/E72E6wn5kNNH/FS7O\nvOBK0P6UNNUmVZS5bWZOYOE+a6GTN6zhk96hhM9uBOixwwN7YIdjfOfHORYX\n3wezNRPU7NoNaZz/IsCqOvfNl2ZZ92wLke8kDucs5E89chCLECacURXje/B4\nlyJlGt86wn/ygXKF3IPg4D82AsmJmPLbxYZz0dShe9G0wCplbHhz94SebdZL\nlaKRhJOoHtw/Yc5frBr54oGi8plYOvBXmmXLvv/jQmazO/DzBoGzw1KWZ16/\n7hxn5DFUJy6yAAzwl93AbF+T96Xd8Fb+XaYgjw1OlTXAp2sIlm4cuSpCF9UX\na/j6jbiGmUeDUJ7ja7GgXR+ccEZmpWud8UKJvI/0cgtI1oLid563i7UIHRJ5\nSEueTECS9qpYikUbrUkn+M8+Beyky4i8XHzfe9PYXm/JPlFy+dyt/ViF615U\n1iB/\r\n=6jHC\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDROr+SQhzueBAiuV2+HfXZy6qEOJuHJGIQyLtv3u0EXAIhALbLpM7xUVgjA8ccCEavfvEFF01XDqPUZcbnKFLTi5ve"}]},"maintainers":[{"email":"davidgwking@gmail.com","name":"davidgwking"},{"email":"seanlgarner@gmail.com","name":"seangarner"}],"_npmUser":{"name":"seangarner","email":"seanlgarner@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/buffer-peek-stream_1.1.0_1580657207102_0.3045778889907236"},"_hasShrinkwrap":false}},"homepage":"https://github.com/seangarner/node-buffer-peek-stream","keywords":["stream","streams","peek","parse","buffer","inspect"],"repository":{"type":"git","url":"git+https://github.com/seangarner/node-buffer-peek-stream.git"},"author":{"name":"Sean Garner"},"bugs":{"url":"https://github.com/seangarner/node-buffer-peek-stream/issues"},"license":"MIT","readmeFilename":"README.md","users":{"joris-van-der-wel":true}}