docs(map, tree): Explicitly call out in SharedMap and SharedTree map node APIs that no enumeration ordering is guaranteed #21146
Conversation
This file contains 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
github-actions
bot
added
area: dds
github-actions
bot
added
the
area: framework
noencke
approved these changes
May 20, 2024
packages/dds/tree/src/feature-libraries/flex-tree/flexTreeTypes.ts
Outdated
Show resolved
Hide resolved
packages/dds/tree/src/feature-libraries/flex-tree/flexTreeTypes.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Noah Encke <[email protected]>
kekachmar
pushed a commit
to kekachmar/FluidFramework
that referenced
this pull request
May 21, 2024
…node APIs that no enumeration ordering is guaranteed (microsoft#21146) In both of these APIs, we attempt to mirror the JavaScript Map APIs, which guarantee enumeration ordering matches insertion order. Neither SharedMap nor SharedTree make such guarantees. This PR adds documentation to make this clear to the end-user. [AB#7955](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/7955)
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.
In both of these APIs, we attempt to mirror the JavaScript Map APIs, which guarantee enumeration ordering matches insertion order. Neither SharedMap nor SharedTree make such guarantees. This PR adds documentation to make this clear to the end-user.
AB#7955