Clarify toObservable VS outputToObservable replay behavior (in JSDoc) #57224
Labels
area: docs
Related to the documentation
core: inputs / outputs
cross-cutting: signals
P3
An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Milestone
Describe the problem that you experienced
A
Model
can be converted to anObservable
with eithertoObservable
oroutputToObservable
.The JSDocs do not make it clear that they have different replay behavior. Though this is described inhttps://angular.dev/guide/signals/rxjs-interop#timing-of-toobservableHowever, the
toObservable
JSDoc (docs you see in IDE) only say:Enter the URL of the topic with the problem
No response
Describe what you were looking for in the documentation
Function JSdocs that help me decide whether I want
toObservable
oroutputToObservable
.Describe the actions that led you to experience the problem
I was using
switchMap
,which subscribes later, making replay a concern.Describe what you want to experience that would fix the problem
toObservable
JSdocs should mention replay.outputToObservable
JSdocs should note that the Observable does not replay.Add a screenshot if that helps illustrate the problem
No response
If this problem caused an exception or error, please paste it here
No response
If the problem is browser-specific, please specify the device, OS, browser, and version
No response
Provide any additional information here in as much as detail as you can
No response
The text was updated successfully, but these errors were encountered: