kewisch / kewisch/ical.js

v.NEXT: Support for async generators (Stream protocol)

Open
#528 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
1.2k
Forks
156
Avg merge
4d 43m
Merged PRs (30d)
3

Description

For your next version. (I read that there is a module-based rewrite in the works! 👍 )

----

- iCal feeds can be quite large
- iCal recurrence computation can get quite lengthy

_Anything_ that involves a potentially long read or computation would benefit greatly from the use of async generators. Parsing and computing recurrence rules are the top two candidates that spring to mind.

----

[This excellent post on 2ality](https://2ality.com/2019/11/nodejs-streams-async-iteration.html) explains the benefits in far greater detail and clarity than I ever could.

The blog post was also the progenitor of [the equivalent section in his book](https://exploringjs.com/impatient-js/ch_async-iteration.html#async-generators) (which presents very similar info, but _slightly_ differently; you may prefer one over the other).

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the project’s parsing and recurrence-computation entry points, then compare their current behavior with the linked async-iteration resources. The issue’s goal is to support async generators through the Stream protocol for potentially long reads and computations, especially iCal parsing and recurrence calculation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.