tc39/proposal-emitter

Typings

Open

#2 opened on May 17, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees) (4 forks)github user discovery
help wanted

Repository metrics

Stars
 (92 stars)
PR merge metrics
 (PR metrics pending)

Description

There was a tonne of helpful feedback from @briancavalier on the exploratory API, trade-offs and internal workings I plan to look into. One thing he mentioned that would be a great first issue for someone else to pick is adding typings to the library.

If you apply an operator on an iterable source, the resulting composed emitter is also iterable. However, not every conceivable emitter is iterable and/or async iterable. This should be easy to statically identify and would make it easier for people to learn.

This sort of information can also be leveraged internally for optimisations, which I wasn't aware of e.g. simplifying a chain of emitters without any visible difference.

Contributor guide

Research direction
Study the emitter API and create TypeScript type definitions covering all functions, ensuring accurate typing for iterable and async iterable emitters.
Tech stack
javascripttypescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80