{"id":17472645,"url":"https://github.com/shinnn/cancelable-pipeline","last_synced_at":"2025-08-04T06:32:38.954Z","repository":{"id":57146038,"uuid":"86053890","full_name":"shinnn/cancelable-pipeline","owner":"shinnn","description":"Cancelable `stream.pipeline()`","archived":false,"fork":false,"pushed_at":"2019-04-08T08:13:12.000Z","size":57,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-22T12:17:10.726Z","etag":null,"topics":["abortable","cancelable","cancelation","javascript","nodejs","pipeline","pump","stream"],"latest_commit_sha":null,"homepage":"https://nodejs.org/api/stream.html#stream_stream_pipeline_streams_callback","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-03-24T10:03:09.000Z","updated_at":"2021-09-15T11:45:08.000Z","dependencies_parsed_at":"2022-09-05T14:10:15.145Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/cancelable-pipeline","commit_stats":null,"previous_names":["shinnn/cancelable-pump"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fcancelable-pipeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fcancelable-pipeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fcancelable-pipeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fcancelable-pipeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/cancelable-pipeline/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228604603,"owners_count":17944281,"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":["abortable","cancelable","cancelation","javascript","nodejs","pipeline","pump","stream"],"created_at":"2024-10-18T17:29:55.016Z","updated_at":"2024-12-07T13:15:38.189Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cancelable-pipeline\n\n[![npm version](https://img.shields.io/npm/v/cancelable-pipeline.svg)](https://www.npmjs.com/package/cancelable-pipeline)\n[![Build Status](https://travis-ci.com/shinnn/cancelable-pipeline.svg?branch=master)](https://travis-ci.com/shinnn/cancelable-pipeline)\n[![codecov](https://codecov.io/gh/shinnn/cancelable-pipeline/branch/master/graph/badge.svg)](https://codecov.io/gh/shinnn/cancelable-pipeline)\n\nCancelable [`stream.pipeline()`](https://nodejs.org/api/stream.html#stream_stream_pipeline_streams_callback)\n\n```javascript\nconst {createReadStream, createWriteStream, promises: {stat}} = require('fs');\nconst cancelablePipeline = require('cancelable-pipeline');\n\ncancelablePipeline(createReadStream('1GB-file.txt'), createWriteStream('dest0'), async () =\u003e {\n  (await stat('dest0')).size; //=\u003e 1000000000;\n});\n\nconst cancel = cancelablePipeline(createReadStream('1GB-file.txt'), createWriteStream('dest1'), async () =\u003e {\n  (await stat('dest1')).size; //=\u003e 263192576, or something else smaller than 1000000000\n});\n\nsetTimeout(() =\u003e cancel(), 1000);\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).\n\n```\nnpm install cancelable-pipeline\n```\n\n## API\n\n```javascript\nconst cancelablePipeline = require('cancelable-pipeline');\n```\n\n### cancelablePipeline(*stream0* [, *stream1*, *stream2*, ...] [, *callback*])\n\n*stream0*, *stream1*, *stream2*, ...: [`Stream`](https://nodejs.org/api/stream.html#stream_stream)  \n*callback*: `Function`  \nReturn: `Function`\n\n### cancelablePipeline(*streams* [, *callback*])\n\n*streams*: `Stream[]`  \n*callback*: `Function`  \nReturn: `Function`\n\nThe API is almost the same as [`stream.pipeline()`](https://nodejs.org/api/stream.html#stream_stream_pipeline_streams_callback). The only difference is *cancelable-pipeline* returns a `Function` which destroys all the piped `Stream`s without passing any errors to the callback.\n\n```javascript\nconst cancel = cancelablePipeline([src, transform, anotherTransform, dest], err =\u003e {\n  err; //=\u003e undefined\n});\n\ncancel();\n```\n\n## License\n\n[ISC License](./LICENSE) © 2017 - 2019 Shinnosuke Watanabe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fcancelable-pipeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Fcancelable-pipeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fcancelable-pipeline/lists"}