README.md

Typescript Fluent Iterators

Provides fluent api operations on iterators, async iterators and promise iterators.

Description

The library provides the common transformation, filtering and aggregation operations on iterators, async iterators and promise iterators.

Quick start guide

Install from Node Package Manager: npm i ts-fluent-iterators

Add the following code to your index file:

import { iterator, Generators } from 'ts-fluent-iterators';

const iter = iterator(Generators.range());

console.log(
  `The first five even numbers are: ${iter
    .filter(n => n % 2 === 0)
    .take(5)
    .collect()}`
);

Operations supported

• Item-by-item transformations:

  • map
  • enumerate

• Group transformations like

  • partition
  • tally

• Extending operations like

  • append
  • prepend
  • concat

• Narrowing operations like

  • filter
  • take
  • takeWhile
  • skip
  • skipWhile
  • first
  • last

• Aggregating operations:

  • collect
  • groupBy
  • tally
  • collectToSet
  • collectTo
  • collectToMap
  • collectToObject
  • fold
  • reduce
  • join
  • count
  • max
  • min

• Logical aggregating operations:

  • all
  • some
  • contains
  • includes

• Execution operations:

  • tap
  • forEach

• Promise specific operations:

  • flatMap
  • allSettled
  • race
  • any

Usage

Click here for the Full API Reference.

License

Licensed under MIT.