ReactiveX/rxjs

Examples from contributor days

Open

#2324 opened on Feb 3, 2017

View on GitHub
 (16 comments) (19 reactions) (2 assignees)TypeScript (31,024 stars) (3,007 forks)batch import
docshelp wanted

Description

At RxJS contributor days we discussed adding an examples/ folder to the repo and populating it with some real use cases for RxJS. Here are the examples we came up with:

  • Design an API using RxJS
  • Synchronizing async executables
  • Sharing expensive fetch data in a lazy way
  • Encouraging immutability
  • Exponential back off (dealing with a rate limited API)
  • Dealing with a bad connection / flaky server
  • Message Queues / Reactive events
  • Stock Ticker
  • Autocomplete
  • Random Walk
  • DOM Events (Double click / Drag n Drop)
  • Polling
  • Multiple HTTP Requests
  • Canvas - Slow Brushstroke
  • Color Picker
  • Animation timeline
  • Game scoreboard
  • Progress of upload (or any ajax)
  • Task manager
  • Custom backpressure
  • Observables that return generators or promises
  • Reqest / Reply pattern on websockets
  • Writing ‘async’ module with RxJS
  • Real error / exception handling
  • Undo and Redo
  • Wrapping now observable processes inside observables
  • Redux inside RxJS
  • Filesystem.js and Process.js
  • Useful .let() examples (combine throttle and debounce for example)
  • Schedulers (dealing with large, stack destroying recursive processes)
  • Re-entrant examples (see RX issues for specific problems)
  • Cancellation
  • Framework specific examples (Angular, React)
  • Effective Interop

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Familiarity with RxJSJavaScript/TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue proposes creating an examples folder with many use cases. Since the scope is broad, it is recommended to focus on a single example, such as 'Autocomplete' or 'Polling'. Review the discussion in issue comments to see if any examples have been started or if there are preferences. Create a new directory 'examples/autocomplete' with a README explaining the example and the RxJS code. Ensure the code follows the RxJS style guide and demonstrates core concepts. Reach out to maintainers via the issue to get feedback on the chosen example before writing extensive code.