Add mergeIterables()

[voxpelli]

Fixes #18

Summary by CodeRabbit

• New Features

  • New mergeIterables() function enables concurrent processing of multiple iterables with configurable buffer size.
  • Enhanced bufferedAsyncMap with optional "ordered" parameter to control result ordering behavior.

• Documentation

  • Updated API documentation for new mergeIterables function and bufferedAsyncMap enhancements.

• Tests

  • Expanded test coverage for mergeIterables functionality and parallel processing validation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[voxpelli]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new mergeIterables() function is added to the public API, enabling parallel processing of multiple async iterables using the existing bufferedAsyncMap mechanism. Documentation is updated, and a test suite verifies the new functionality. Test structure is refactored by removing nested describe wrappers.

Changes

Cohort / File(s)	Summary
Documentation README.md	Updated bufferedAsyncMap() API header and signature to include new ordered parameter in options. Added new mergeIterables() public API entity with syntax, options (bufferSize), and behavior documentation.
Core Implementation index.js	Added private async generator function yieldIterable(item) that yields from provided items. Added public async generator export mergeIterables(input, { bufferSize } = {}) that delegates to bufferedAsyncMap using yieldIterable as the callback.
Test Suite test/values.spec.js	Added import of mergeIterables. New test suite verifies parallel processing and aggregated output duration. Refactored existing test structure by removing nested "main" describe wrapper and promoting contained tests to top-level blocks. Updated assertions and minor test description wording.

Sequence Diagram

sequenceDiagram
    participant User
    participant mergeIterables
    participant bufferedAsyncMap
    participant yieldIterable
    participant Iterator as Individual Iterator

    User->>mergeIterables: mergeIterables(input, options)
    mergeIterables->>bufferedAsyncMap: bufferedAsyncMap(input, yieldIterable, options)
    
    loop For each item in input
        bufferedAsyncMap->>yieldIterable: yieldIterable(item)
        yieldIterable->>Iterator: yield * item
        Iterator-->>yieldIterable: values from iterator
        yieldIterable-->>bufferedAsyncMap: aggregated yields
    end
    
    bufferedAsyncMap-->>mergeIterables: merged async iterable
    mergeIterables-->>User: merged results

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• New logic: mergeIterables and yieldIterable require verification of correct delegation to bufferedAsyncMap and async generator semantics
• Test refactoring: Structural changes to test organization require careful review to ensure no test logic was altered unintentionally
• Documentation completeness: Verify API documentation accurately reflects new parameter and function signatures

Poem

🐰 A merger of streams flows swift and bright,
Multiple iterables unified in flight!
With buffers and yields, our rabbit rejoice,
Async flows dancing—one merged voice! ✨

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch merge-iterables

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c458e0 and dae49ab.

📒 Files selected for processing (3)

• README.md (2 hunks)
• index.js (1 hunks)
• test/values.spec.js (4 hunks)

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}