Data

Tools

Indexes

Applications

Experiments

Open Source Science

iter-flow

Create a fluent interface for chaining together iterator methods.

https://github.com/stdlib-js/iter-flow

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary

Keywords

chain flow fluent funseq iter iterate iterator javascript node node-js nodejs pipe pipeline stdlib stream util utilities utility utils
Last synced: 6 months ago · JSON representation ·

Repository

Create a fluent interface for chaining together iterator methods.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
chain flow fluent funseq iter iterate iterator javascript node node-js nodejs pipe pipeline stdlib stream util utilities utility utils
Created over 4 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We 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.

The 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.

When 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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterFlow

NPM version Build Status Coverage Status <!-- dependencies -->

Create a fluent interface for chaining together iterator methods.

## Installation ```bash npm install @stdlib/iter-flow ``` Alternatively, - 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]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - 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]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To 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.
## Usage ```javascript var iterFlow = require( '@stdlib/iter-flow' ); ``` #### iterFlow( methods ) Returns a fluent interface [iterator][mdn-iterator-protocol] constructor with a customized `prototype` based on provided `methods`. ```javascript var iterHead = require( '@stdlib/iter-head' ); var iterSome = require( '@stdlib/iter-some' ); // Create a mini-fluent interface having just the methods `head` and `some`: var FluentIterator = iterFlow({ 'head': iterHead, 'some': iterSome }); ``` The `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: ```text function iterFcn( iterator[, ...args] ) {...} ``` where - **iterator**: an [iterator][mdn-iterator-protocol]. - **...args**: additional [iterator][mdn-iterator-protocol] function arguments. When 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. If 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. * * * ##### FluentIterator( iterator ) Returns a new fluent interface [iterator][mdn-iterator-protocol] from a source [`iterator`][mdn-iterator-protocol]. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var iterHead = require( '@stdlib/iter-head' ); var iterSome = require( '@stdlib/iter-some' ); // Create a mini-fluent interface having just the methods `head` and `some`: var FluentIterator = iterFlow({ 'head': iterHead, 'some': iterSome }); // Create a source iterator: var src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] ); // Convert the source iterator to a fluent interface iterator: var it = new FluentIterator( src ); // Test if at least 3 of the first 5 iterated values are truthy: var bool = it.head( 5 ).some( 3 ); // returns true ``` ##### FluentIterator.prototype.next() Returns 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. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var iterHead = require( '@stdlib/iter-head' ); var iterSome = require( '@stdlib/iter-some' ); // Create a mini-fluent interface having just the methods `head` and `some`: var FluentIterator = iterFlow({ 'head': iterHead, 'some': iterSome }); // Create a source iterator: var src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] ); // Create a fluent interface iterator: var it1 = new FluentIterator( src ); // Invoke the `head` method to return an iterator limited to the first 5 source values: var it2 = it1.head( 5 ); // Perform manual iteration... var v; while ( true ) { v = it2.next(); if ( v.done ) { break; } console.log( v.value ); } ``` ##### FluentIterator.prototype.return( \[value] ) Closes a fluent interface [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var iterHead = require( '@stdlib/iter-head' ); var iterSome = require( '@stdlib/iter-some' ); // Create a mini-fluent interface having just the methods `head` and `some`: var FluentIterator = iterFlow({ 'head': iterHead, 'some': iterSome }); // Create a source iterator: var src = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] ); // Create a fluent interface iterator: var it1 = new FluentIterator( src ); // Invoke the `head` method to return an iterator limited to the first 5 source values: var it2 = it1.head( 5 ); // Get the first value: var v = it2.next().value; // returns 0 // Get the second value: v = it2.next().value; // returns 0 // Get the third value: v = it2.next().value; // returns 1 // Close the iterator: var bool = it2.return().done; // returns true // Attempt to get the fourth value: v = it2.next().value; // returns undefined ```
## Notes - The [iterator][mdn-iterator-protocol] function evaluation context is **always** `null`. - [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). - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
## Examples ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); var iterHead = require( '@stdlib/iter-head' ); var iterSome = require( '@stdlib/iter-some' ); var iterFlow = require( '@stdlib/iter-flow' ); // Create a "fluent" interface: var FluentIterator = iterFlow({ 'head': iterHead, 'some': iterSome }); // Create a source iterator: var arr = array2iterator( [ 0, 0, 1, 1, 1, 0, 0, 1, 0, 1 ] ); // Create a new iterator: var it = new FluentIterator( arr ); var bool = it.head( 5 ).some( 3 ); // returns true // Create another source iterator: arr = array2iterator( [ 0, 0, 1, 0, 1, 0, 0, 1, 0, 1 ] ); // Create a new iterator: it = new FluentIterator( arr ); bool = it.head( 5 ).some( 3 ); // returns false ```
* * * ## See Also - [`@stdlib/iter-pipeline`][@stdlib/iter/pipeline]: create an iterator pipeline.
* * * ## Notice This 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. For 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]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 20
Last Year
  • Push event: 20

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 51
  • Total Committers: 1
  • Avg Commits per committer: 51.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 51
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • @stdlib/array-to-iterator ^0.0.x development
  • @stdlib/assert-is-boolean ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/iter-head ^0.0.x development
  • @stdlib/iter-some ^0.0.x development
  • @stdlib/iter-some-by ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/random-iter-randu ^0.0.x development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-is-function ^0.0.x
  • @stdlib/assert-is-iterator-like ^0.0.x
  • @stdlib/assert-is-object ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/symbol-iterator ^0.0.x
  • @stdlib/types ^0.0.x
  • @stdlib/utils-define-nonenumerable-property ^0.0.x
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
  • @stdlib/utils-keys ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite