rxjs icon indicating copy to clipboard operation
rxjs copied to clipboard

[Docs] some 6 to 7 breaking changes hidden in the Detailed change list (or missing)

Open karptonite opened this issue 3 years ago • 1 comments

The main docs page for RxJS, https://rxjs.dev/, currently has two main headers related to changes related to the 6 to 7 updates. One is called "Deprecations and Breaking Changes" and one is called "Detailed Change List". However, some actual breaking changes are included only in the Detailed Change List.

Specifically, debounce and the duration option for groupBy require an observable that emits a next, not just one that completes, to end the duration. The documentation for the change to debounce is in the "Detailed Change List", while it appears that there is no documentation for the change to groupBy.

Missing these issues broke our app in two places, where we were using (with some other logic) EMPTY.delay(time) to trigger debounce or groupBy durations.

One simple thing that might help, for at least the debounce issue, would be to pull the "Detailed Change List" under "Deprecations and Breaking Change" in the menu. My incorrect assumption was that the detailed list was just informational, for those interested in how RxJS had been improved under the hood.

Sorry this is coming up so late--the recent update of NgRX to support RxJS 7 allowed us to finally update our own application, so I'm just coming across these issues now.

karptonite avatar Oct 25 '21 13:10 karptonite

Ran into this today with a debounce operator which returned of() in some scenarios. Switching to of(true) fixes.

jonapgartwohat avatar May 11 '22 19:05 jonapgartwohat