Genflow - Utility Library for generators

Inspired by python itertools, Genflow provides a collection of utility functions for chaining generator functions. It offers a wide range of operations, allowing you to process and manipulate data in various ways.

Installation

To use Genflow in your project, you can install it via npm:

npm install genflow

Usage

Import the genflow module code:

import genflow from "genflow";

Here are some examples of how to use genflow:

Example 1: Creating an Iterable of Numbers

// Generates an iterable of numbers from 1 to 9
const numbers = genflow.range(1, 10);

for (const num of numbers) {
  console.log(num);
}

Example 2: Applying Filtering and Mapping

const data = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];

const filteredAndMapped = genflow
  // Filters even numbers
  .filter(data, (num) => num % 2 === 0)
  // Doubles the filtered numbers
  .map((num) => num * 2);

// Outputs: 4, 8, 12, 16, 20
for (const num of filteredAndMapped) {
  console.log(num);
}

Example 3: Creating a Sliding Window

const text = ["This", "is", "a", "sample", "text", "for", "window", "example"];
const windowSize = 3;
const slidingWindow = genflow.window(text, windowSize);

// Outputs arrays of 3 adjacent words
for (const window of slidingWindow) {
  console.log(window);
}

For a complete list of available functions and their usage, refer to the API Documentation section.

API Documentation

Genflow provides a collection of utility functions and a wrapper class for iterables. Here's a list of available functions:

• count(start?: number, step?: number): Genflow<number>
• range(start?: number, stop?: number, step?: number): Genflow<number>
• accumulate<T>(iterable: Iterable<T>, operator: Operator<T>, initial?: T | undefined): Genflow<T>
• enumerate<T>(iterable: Iterable<T>): Genflow<[number, T]>
• take<T>(iterable: Iterable<T>, number: number): Genflow<T>
• cycle<T>(iterable: Iterable<T>, times?: number): Genflow<T | undefined>
• tee<T>(iterable: Iterable<T>, splits?: number): Genflow<Genflow<T>>
• drop<T>(iterable: Iterable<T>, items?: number): Genflow<T>
• step<T>(iterable: Iterable<T>, step?: number): Genflow<T>
• slice<T>(iterable: Iterable<T>, start?: number, stop?: number | null, step?: number): Genflow<T>
• zip<T>(...iterables: Iterable<T>[]): Genflow<(void | T)[]>
• map<T, R>(iterable: Iterable<T>, func: (item: T) => R): Genflow<R>
• window<T>(iterable: Iterable<T>, n?: number): Genflow<(void | Generator<never, Iterable<T>, unknown>)[]>
• flatten<T>(iterable: Iterable<T>): Genflow<T>
• filter<T>(iterable: Iterable<T>, predicate?: (item: T) => boolean): Genflow<T>
• filterMap<T, R>(iterable: Iterable<T>, predicate: (item: T) => R | null | undefined): Genflow<R>

Contributing

If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the GitHub repository.

License

Genflow is released under the MIT License.

This module was developed by James Schinner. If you find it helpful, consider giving it a star on GitHub!