{"id":26977454,"url":"https://github.com/seangarner/node-buffer-peek-stream","last_synced_at":"2025-04-03T12:27:43.885Z","repository":{"id":22892711,"uuid":"26241061","full_name":"seangarner/node-buffer-peek-stream","owner":"seangarner","description":"Node Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it","archived":false,"fork":false,"pushed_at":"2024-06-17T00:29:19.000Z","size":66,"stargazers_count":7,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-01T16:41:34.375Z","etag":null,"topics":["javascript","node-streams","nodejs","stream"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seangarner.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-05T21:41:47.000Z","updated_at":"2022-04-05T20:48:12.000Z","dependencies_parsed_at":"2022-09-06T17:31:20.521Z","dependency_job_id":null,"html_url":"https://github.com/seangarner/node-buffer-peek-stream","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seangarner%2Fnode-buffer-peek-stream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seangarner%2Fnode-buffer-peek-stream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seangarner%2Fnode-buffer-peek-stream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seangarner%2Fnode-buffer-peek-stream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seangarner","download_url":"https://codeload.github.com/seangarner/node-buffer-peek-stream/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246746894,"owners_count":20827062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","node-streams","nodejs","stream"],"created_at":"2025-04-03T12:27:43.251Z","updated_at":"2025-04-03T12:27:43.878Z","avatar_url":"https://github.com/seangarner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseangarner%2Fnode-buffer-peek-stream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseangarner%2Fnode-buffer-peek-stream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseangarner%2Fnode-buffer-peek-stream/lists"}