Improves observable docs #272900
Open
Improves observable docs #272900
+9
−3
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the observable system's type safety and documentation by introducing a conditional type helper and clarifying the IReader interface's purpose.
Key changes:
- Introduces
IObservableWithOptionalChangeconditional type to differentiate observables with and without change tracking - Updates
derivedfunction signatures to use the new conditional type - Adds JSDoc documentation for the
IReaderinterface
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/vs/base/common/observableInternal/base.ts | Defines new IObservableWithOptionalChange conditional type and adds documentation for IReader |
| src/vs/base/common/observableInternal/observables/derived.ts | Updates derived function signatures to return IObservableWithOptionalChange instead of IObservableWithChange |
Tyriar
approved these changes
Oct 23, 2025
Member
|
Red CI |
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.
No description provided.