From 5426e7d13366cd27eb923dfb4834d0cafaa39b0a Mon Sep 17 00:00:00 2001 From: Nicholas Jamieson Date: Sat, 1 May 2021 02:26:25 +1000 Subject: [PATCH] docs: add notifier breaking changes (#6299) Closes #6298 --- docs_app/content/6-to-7-change-summary.md | 32 +++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs_app/content/6-to-7-change-summary.md b/docs_app/content/6-to-7-change-summary.md index 95103c5d7a..a797abffd6 100644 --- a/docs_app/content/6-to-7-change-summary.md +++ b/docs_app/content/6-to-7-change-summary.md @@ -193,10 +193,22 @@ This document contains a detailed list of changes between RxJS 6.x and RxJS 7.x, ## Breaking Changes +### audit + +- The observable returned by the `audit` operator's duration selector must emit a next notification to end the duration. Complete notifications no longer end the duration. + ### buffer - `buffer` now subscribes to the source observable before it subscribes to the closing notifier. Previously, it subscribed to the closing notifier first. +### bufferToggle + +- The observable returned by the `bufferToggle` operator's closing selector must emit a next notification to close the buffer. Complete notifications no longer close the buffer. + +### bufferWhen + +- The observable returned by the `bufferWhen` operator's closing selector must emit a next notification to close the buffer. Complete notifications no longer close the buffer. + ### combineLatest - Generic signatures have changed. Do not explicitly pass generics. @@ -214,10 +226,18 @@ This document contains a detailed list of changes between RxJS 6.x and RxJS 7.x, - Generic signatures have changed. Do not explicitly pass generics. +### debounce + +- The observable returned by the `debounce` operator's duration selector must emit a next notification to end the duration. Complete notifications no longer end the duration. + ### defaultIfEmpty - Generic signatures have changed. Do not explicitly pass generics. +### delayWhen + +- `delayWhen` will no longer emit if the duration selector simply completes without a value. Notifiers must notify with a value, not a completion. + ### endWith - Generic signatures have changed. Do not explicitly pass generics. @@ -247,6 +267,10 @@ This document contains a detailed list of changes between RxJS 6.x and RxJS 7.x, - Generic signatures have changed. Do not explicitly pass generics. +### sample + +- The `sample` operator's notifier observable must emit a next notification to effect a sample. Complete notifications no longer effect a sample. + ### scan - Generic signatures have changed. Do not explicitly pass generics. @@ -263,6 +287,14 @@ This document contains a detailed list of changes between RxJS 6.x and RxJS 7.x, - Generic signatures have changed. Do not explicitly pass generics. +### throttle + +- The observable returned by the `throttle` operator's duration selector must emit a next notification to end the duration. Complete notifications no longer end the duration. + +### windowToggle + +- The observable returned by the `windowToggle` operator's closing selector must emit a next notification to close the window. Complete notifications no longer close the window. + ### withLatestFrom - Generic signatures have changed. Do not explicitly pass generics.