docs: add NG0991 error page and document rxResource's completion contract - #70259
Open
arturovt wants to merge 1 commit into
Open
docs: add NG0991 error page and document rxResource's completion contract#70259arturovt wants to merge 1 commit into
arturovt wants to merge 1 commit into
Conversation
JeanMeche
reviewed
Aug 18, 2026
arturovt
force-pushed
the
docs/ng0991-resource-completed-error-page
branch
from
August 19, 2026 05:42
bc82e97 to
62fde36
Compare
JeanMeche
reviewed
Aug 23, 2026
|
|
||
| In all other ways, `rxResource` behaves like and provides the same APIs as `resource` for specifying parameters, reading values, checking loading state, and examining errors. | ||
|
|
||
| ### The stream must produce a value or an error |
Member
There was a problem hiding this comment.
I don't think it's worthy of overloading the guide with this.
…ract RESOURCE_COMPLETED_BEFORE_PRODUCING_VALUE had no guide, no JSDoc on RxResourceOptions.stream, and — since the code was positive rather than negative — could never get an auto-linked docs page even if one existed. Flip it to -991, add the NG0991 reference page, and document the "stream must emit a value or an error before completing" requirement on stream's JSDoc and in the RxJS interop guide. Also documents and tests that an unguarded template read of an errored resource's .value() propagates to the global ErrorHandler, and recommends guarding with .hasValue() as defense in depth. httpResource can throw the same error, but for a different reason: its internal request Observable isn't something app code writes directly, so an empty completion there is almost always an HttpInterceptor swallowing the response (catchError(() => EMPTY)) rather than a stream authored in the resource() call itself. The page covers both APIs with guidance matched to what's actually going on for each.
arturovt
force-pushed
the
docs/ng0991-resource-completed-error-page
branch
from
August 25, 2026 13:03
62fde36 to
785ab66
Compare
JeanMeche
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RESOURCE_COMPLETED_BEFORE_PRODUCING_VALUEhad no guide, no JSDoc onRxResourceOptions.stream, and — since the code was positive rather than negative — could never get an auto-linked docs page even if one existed. Flip it to -991, add the NG0991 reference page, and document the "stream must emit a value or an error before completing" requirement onstream's JSDoc and in the RxJS interop guide.Also documents and tests that an unguarded template read of an errored resource's
.value()propagates to the globalErrorHandler, and recommends guarding with.hasValue()as defense in depth.