sindresorhus/p-map

Allow breaking from iterator

Open

#31 opened on Oct 13, 2020

View on GitHub
 (15 comments) (0 reactions) (0 assignees)JavaScript (66 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (1,499 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I wish I could stop the iteration early by returning something like pMap.stop (a Symbol) from the iterator.

This is basically the same request as https://github.com/sindresorhus/p-each-series/issues/3

For now, I have to throw an error on purpose just to break it. Thankfully, I don't need the return value of p-map anyway.

But with this feature, the parts of the array that weren't computed yet could be set to undefined, or pMap.uncomputed (another Symbol), or even be specified by a valueForUncomputedEarlyStop option.

Can I do a PR?

Contributor guide

Research direction
Examine the p map source code to understand the iteration loop. Then implement a mechanism to check for a stop symbol returned from the mapper function and break the loop accordingly. Update documentation and add tests.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70