ReactiveX / ReactiveX/rxjs

Add documentation about why people should almost never inherit from our exports.

Open
#5,644 0 comments 2 reactions 1 assignee View on GitHub

@benlesh is already working on this.

Since Aug 13, 2020.

Dominant language
TypeScript
Stars
31.7k
Forks
3k
PR merge metrics
No merged PRs in 30d

Description

There are a lot of issues with doing this, and I think it needs to be in the official documentation that people should avoid doing it, and if they're doing it they're "voiding the warranty", so to speak.

High level:

  • How they can end up relying on implementation details.
  • How custom observables and subjects can break operators.
  • etc.

Tangentially related #5431

I'll probably add this to the new guide in #5592

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.