{"id":15297220,"url":"https://github.com/stdlib-js/iter-pipeline","last_synced_at":"2026-01-29T08:33:48.152Z","repository":{"id":41383826,"uuid":"376836431","full_name":"stdlib-js/iter-pipeline","owner":"stdlib-js","description":"Create an iterator pipeline.","archived":false,"fork":false,"pushed_at":"2024-12-01T08:49:35.000Z","size":875,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T00:12:45.054Z","etag":null,"topics":["flow","funseq","iter","iterate","iterator","javascript","node","node-js","nodejs","pipe","pipeline","stdlib","stream","util","utilities","utility","utils"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-14T13:40:19.000Z","updated_at":"2024-12-01T03:46:50.000Z","dependencies_parsed_at":"2023-09-23T18:14:05.549Z","dependency_job_id":"cb081d53-3ac0-4868-9070-8ad5638df708","html_url":"https://github.com/stdlib-js/iter-pipeline","commit_stats":{"total_commits":64,"total_committers":1,"mean_commits":64.0,"dds":0.0,"last_synced_commit":"e61cbc75a495b89db1f02033866a4e35ba53a8ea"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-pipeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-pipeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-pipeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-pipeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/iter-pipeline/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643004,"owners_count":21138355,"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":["flow","funseq","iter","iterate","iterator","javascript","node","node-js","nodejs","pipe","pipeline","stdlib","stream","util","utilities","utility","utils"],"created_at":"2024-09-30T19:15:42.756Z","updated_at":"2026-01-29T08:33:48.136Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2019 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# iterPipeline\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Create an [iterator][mdn-iterator-protocol] pipeline.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/iter-pipeline\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar iterPipeline = require( '@stdlib/iter-pipeline' );\n```\n\n#### iterPipeline( iterFcn0\\[, ...iterFcn] )\n\nReturns an [iterator][mdn-iterator-protocol] pipeline.\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterThunk = require( '@stdlib/iter-pipeline-thunk' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\n// Convert iterator functions to unary functions which accept an iterator:\nvar it1 = iterThunk( iterHead, 5 );\nvar it2 = iterThunk( iterSome, 3 );\n\n// Create an iterator pipeline:\nvar p = iterPipeline( it1, it2 );\n\n// Create a source iterator:\nvar arr = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 0, 1, 1 ] );\n\n// Provide the source iterator to our iterator pipeline:\nvar bool = p( arr );\n// returns true\n\n// Create a new source iterator:\narr = array2iterator( [ 0, 0, 1, 0, 1, 0, 0, 0, 1, 1 ] );\n\n// Run the pipeline for the new source iterator:\nbool = p( arr );\n// returns false\n```\n\nThe function accepts [iterator][mdn-iterator-protocol] functions provided as separate arguments **or** as a single argument consisting of an array of [iterator][mdn-iterator-protocol] functions.\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterThunk = require( '@stdlib/iter-pipeline-thunk' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\nvar it1 = iterThunk( iterHead, 5 );\nvar it2 = iterThunk( iterSome, 3 );\n\nvar p = iterPipeline( [ it1, it2 ] );\n\nvar arr = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 0, 1, 1 ] );\nvar bool = p( arr );\n// returns true\n\narr = array2iterator( [ 0, 0, 1, 0, 1, 0, 0, 0, 1, 1 ] );\nbool = p( arr );\n// returns false\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   Within the context of an [iterator][mdn-iterator-protocol] pipeline (as defined by this function), an [iterator][mdn-iterator-protocol] function is defined as a **unary** function which accepts an [iterator][mdn-iterator-protocol] as its **only** argument.\n-   Each [iterator][mdn-iterator-protocol] function, except the last [iterator][mdn-iterator-protocol] function, within an [iterator][mdn-iterator-protocol] pipeline must return an [iterator][mdn-iterator-protocol].\n-   Starting from the left, each returned [iterator][mdn-iterator-protocol] is passed to the next [iterator][mdn-iterator-protocol] function.\n-   The result of the last [iterator][mdn-iterator-protocol] function is the result of the pipeline.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint-disable function-call-argument-newline, function-paren-newline --\u003e\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar randu = require( '@stdlib/random-iter-randu' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterMap = require( '@stdlib/iter-map' );\nvar iterSome = require( '@stdlib/iter-some' );\nvar iterThunk = require( '@stdlib/iter-pipeline-thunk' );\nvar iterPipeline = require( '@stdlib/iter-pipeline' );\n\nfunction threshold( r ) {\n    return ( r \u003e 0.95 );\n}\n\n// Create a pipeline which tests whether at least 5% of values exceed a threshold:\nvar p = iterPipeline(\n    // Apply a threshold to iterated values:\n    iterThunk( iterMap, threshold ),\n\n    // Limit the sequence to 100 values:\n    iterThunk( iterHead, 100 ),\n\n    // Test whether at least 5 values exceed the threshold:\n    iterThunk( iterSome, 5 )\n);\n\n// Define the number of random number sequences to analyze:\nvar N = 100;\n\n// Initialize a counter for sequences satisfying the 5% threshold:\nvar count = 0;\n\n// Perform analysis...\nvar bool;\nvar i;\nfor ( i = 0; i \u003c N; i++ ) {\n    bool = p( randu() );\n    if ( bool ) {\n        count += 1;\n    }\n    console.log( bool );\n}\nconsole.log( '%d of %d', count, N );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/iter-flow`][@stdlib/iter/flow]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate a fluent interface for chaining together iterator methods.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/iter-pipeline-thunk`][@stdlib/iter/pipeline-thunk]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator thunk.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/iter-pipeline.svg\n[npm-url]: https://npmjs.org/package/@stdlib/iter-pipeline\n\n[test-image]: https://github.com/stdlib-js/iter-pipeline/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/iter-pipeline/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/iter-pipeline/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/iter-pipeline?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/iter-pipeline.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/iter-pipeline/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/iter-pipeline/tree/deno\n[deno-readme]: https://github.com/stdlib-js/iter-pipeline/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/iter-pipeline/tree/umd\n[umd-readme]: https://github.com/stdlib-js/iter-pipeline/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/iter-pipeline/tree/esm\n[esm-readme]: https://github.com/stdlib-js/iter-pipeline/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/iter-pipeline/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/iter-pipeline/main/LICENSE\n\n[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/iter/flow]: https://github.com/stdlib-js/iter-flow\n\n[@stdlib/iter/pipeline-thunk]: https://github.com/stdlib-js/iter-pipeline-thunk\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fiter-pipeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fiter-pipeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fiter-pipeline/lists"}