{"id":24818680,"url":"https://github.com/stdlib-js/iter-flow","last_synced_at":"2025-10-13T20:30:34.234Z","repository":{"id":41383344,"uuid":"376898393","full_name":"stdlib-js/iter-flow","owner":"stdlib-js","description":"Create a fluent interface for chaining together iterator methods.","archived":false,"fork":false,"pushed_at":"2025-03-10T02:14:24.000Z","size":1136,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-30T20:18:54.998Z","etag":null,"topics":["chain","flow","fluent","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-14T17:04:38.000Z","updated_at":"2025-03-10T01:29:11.000Z","dependencies_parsed_at":"2023-09-24T01:37:50.955Z","dependency_job_id":"99f2cda4-aa10-49a9-bbdb-1154a28ac0fa","html_url":"https://github.com/stdlib-js/iter-flow","commit_stats":{"total_commits":51,"total_committers":1,"mean_commits":51.0,"dds":0.0,"last_synced_commit":"c93fca131a9ccca21d998d376ccd383b0d6ea0bc"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/iter-flow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/iter-flow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fiter-flow/sbom","scorecard":{"id":847970,"data":{"date":"2025-08-11","repo":{"name":"github.com/stdlib-js/iter-flow","commit":"2fc42a9cfd16298ae311880aa8408d3d4f62f3b7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Security-Policy","score":9,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/iter-flow/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/iter-flow/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/iter-flow/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/iter-flow/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/iter-flow/productionize.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83","Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93","Info:  33 out of  33 GitHub-owned GitHubAction dependencies pinned","Info:  19 out of  24 third-party GitHubAction dependencies pinned","Info:   0 out of  32 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/benchmark.yml:1","Warn: no topLevel permission defined: .github/workflows/cancel.yml:1","Warn: no topLevel permission defined: .github/workflows/close_pull_requests.yml:1","Warn: no topLevel permission defined: .github/workflows/examples.yml:1","Warn: no topLevel permission defined: .github/workflows/npm_downloads.yml:1","Warn: no topLevel permission defined: .github/workflows/productionize.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/test_bundles.yml:1","Warn: no topLevel permission defined: .github/workflows/test_coverage.yml:1","Warn: no topLevel permission defined: .github/workflows/test_install.yml:1","Warn: no topLevel permission defined: .github/workflows/test_published_package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T21:51:55.106Z","repository_id":41383344,"created_at":"2025-08-23T21:51:55.106Z","updated_at":"2025-08-23T21:51:55.106Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016921,"owners_count":26085908,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["chain","flow","fluent","funseq","iter","iterate","iterator","javascript","node","node-js","nodejs","pipe","pipeline","stdlib","stream","util","utilities","utility","utils"],"created_at":"2025-01-30T17:37:19.810Z","updated_at":"2025-10-13T20:30:34.229Z","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# iterFlow\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 a fluent interface for chaining together [iterator][mdn-iterator-protocol] methods.\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-flow\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 iterFlow = require( '@stdlib/iter-flow' );\n```\n\n#### iterFlow( methods )\n\nReturns a fluent interface [iterator][mdn-iterator-protocol] constructor with a customized `prototype` based on provided `methods`.\n\n```javascript\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\n// Create a mini-fluent interface having just the methods `head` and `some`:\nvar FluentIterator = iterFlow({\n    'head': iterHead,\n    'some': iterSome\n});\n```\n\nThe `methods` argument should be an `object` which maps constructor method names to [iterator][mdn-iterator-protocol] functions. Each [iterator][mdn-iterator-protocol] function should have the following function signature:\n\n```text\nfunction iterFcn( iterator[, ...args] ) {...}\n```\n\nwhere\n\n-   **iterator**: an [iterator][mdn-iterator-protocol].\n-   **...args**: additional [iterator][mdn-iterator-protocol] function arguments.\n\nWhen a fluent interface [iterator][mdn-iterator-protocol] method is invoked, the method invokes the corresponding [iterator][mdn-iterator-protocol] function with an [iterator][mdn-iterator-protocol] and provided method arguments.\n\nIf an [iterator][mdn-iterator-protocol] function returns an [iterator][mdn-iterator-protocol], the corresponding fluent interface method returns a **new** fluent interface instance; otherwise, the corresponding fluent interface method returns the [iterator][mdn-iterator-protocol] function result.\n\n* * *\n\n##### FluentIterator( iterator )\n\nReturns a new fluent interface [iterator][mdn-iterator-protocol] from a source [`iterator`][mdn-iterator-protocol].\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\n// Create a mini-fluent interface having just the methods `head` and `some`:\nvar FluentIterator = iterFlow({\n    'head': iterHead,\n    'some': iterSome\n});\n\n// Create a source iterator:\nvar src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] );\n\n// Convert the source iterator to a fluent interface iterator:\nvar it = new FluentIterator( src );\n\n// Test if at least 3 of the first 5 iterated values are truthy:\nvar bool = it.head( 5 ).some( 3 );\n// returns true\n```\n\n##### FluentIterator.prototype.next()\n\nReturns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\n// Create a mini-fluent interface having just the methods `head` and `some`:\nvar FluentIterator = iterFlow({\n    'head': iterHead,\n    'some': iterSome\n});\n\n// Create a source iterator:\nvar src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] );\n\n// Create a fluent interface iterator:\nvar it1 = new FluentIterator( src );\n\n// Invoke the `head` method to return an iterator limited to the first 5 source values:\nvar it2 = it1.head( 5 );\n\n// Perform manual iteration...\nvar v;\nwhile ( true ) {\n    v = it2.next();\n    if ( v.done ) {\n        break;\n    }\n    console.log( v.value );\n}\n```\n\n##### FluentIterator.prototype.return( \\[value] )\n\nCloses a fluent interface [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\n\n// Create a mini-fluent interface having just the methods `head` and `some`:\nvar FluentIterator = iterFlow({\n    'head': iterHead,\n    'some': iterSome\n});\n\n// Create a source iterator:\nvar src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] );\n\n// Create a fluent interface iterator:\nvar it1 = new FluentIterator( src );\n\n// Invoke the `head` method to return an iterator limited to the first 5 source values:\nvar it2 = it1.head( 5 );\n\n// Get the first value:\nvar v = it2.next().value;\n// returns 0\n\n// Get the second value:\nv = it2.next().value;\n// returns 0\n\n// Get the third value:\nv = it2.next().value;\n// returns 1\n\n// Close the iterator:\nvar bool = it2.return().done;\n// returns true\n\n// Attempt to get the fourth value:\nv = it2.next().value;\n// returns undefined\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* * *\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   The [iterator][mdn-iterator-protocol] function evaluation context is **always** `null`.\n-   [Iterator][mdn-iterator-protocol] functions which return [iterators][mdn-iterator-protocol] are **expected** to return [iterator][mdn-iterator-protocol] protocol-compliant objects (i.e., an `object` having a `next` method which returns the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished).\n-   If an environment supports `Symbol.iterator`, the returned iterator is iterable.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n* * *\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar array2iterator = require( '@stdlib/array-to-iterator' );\nvar iterHead = require( '@stdlib/iter-head' );\nvar iterSome = require( '@stdlib/iter-some' );\nvar iterFlow = require( '@stdlib/iter-flow' );\n\n// Create a \"fluent\" interface:\nvar FluentIterator = iterFlow({\n    'head': iterHead,\n    'some': iterSome\n});\n\n// Create a source iterator:\nvar arr = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] );\n\n// Create a new iterator:\nvar it = new FluentIterator( arr );\n\nvar bool = it.head( 5 ).some( 3 );\n// returns true\n\n// Create another source iterator:\narr = array2iterator( [ 0, 0, 1, 0, 1, 0, 0, 1, 0, 1 ] );\n\n// Create a new iterator:\nit = new FluentIterator( arr );\n\nbool = it.head( 5 ).some( 3 );\n// returns false\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-pipeline`][@stdlib/iter/pipeline]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator pipeline.\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-flow.svg\n[npm-url]: https://npmjs.org/package/@stdlib/iter-flow\n\n[test-image]: https://github.com/stdlib-js/iter-flow/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/iter-flow/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/iter-flow/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/iter-flow?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/iter-flow.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/iter-flow/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-flow/tree/deno\n[deno-readme]: https://github.com/stdlib-js/iter-flow/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/iter-flow/tree/umd\n[umd-readme]: https://github.com/stdlib-js/iter-flow/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/iter-flow/tree/esm\n[esm-readme]: https://github.com/stdlib-js/iter-flow/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/iter-flow/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/iter-flow/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/pipeline]: https://github.com/stdlib-js/iter-pipeline\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-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fiter-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fiter-flow/lists"}