Split public and internal IFluidHandle APIs #20123
Merged
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
github-actions
bot
added
area: dds: sharedstring
area: tests
CraigMacomber
commented
Apr 24, 2024
noencke
approved these changes
May 1, 2024
anthony-murphy
approved these changes
May 3, 2024
12 tasks
jason-ha
reviewed
May 16, 2024
Comment on lines
+71
to
+90
| * @alpha | ||
| */ | ||
| export function toFluidHandleInternal<T>(handle: IFluidHandle<T>): IFluidHandleInternal<T> { | ||
| if (!(fluidHandleSymbol in handle) || !(fluidHandleSymbol in handle[fluidHandleSymbol])) { | ||
| if (enableBackwardsCompatibility && IFluidHandle in handle) { | ||
| return handle[IFluidHandle] as IFluidHandleInternal<T>; | ||
| } | ||
| throw new TypeError("Invalid IFluidHandle"); | ||
| } | ||
|
|
||
| // This casts the IFluidHandleErased from the symbol instead of `handle` to ensure that if someone | ||
| // implements their own IFluidHandle in terms of an existing handle, it won't break anything. | ||
| return handle[fluidHandleSymbol] as unknown as IFluidHandleInternal<T>; | ||
| } | ||
|
|
||
| /** | ||
| * Type erase IFluidHandleInternal for use with {@link @fluidframework/core-interfaces#fluidHandleSymbol}. | ||
| * @alpha | ||
| */ | ||
| export function toFluidHandleErased<T>(handle: IFluidHandleInternal<T>): IFluidHandleErased<T> { |
There was a problem hiding this comment.
Wasn't possible to make these internal (yet)?
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.
Description
Split IFluidHandle into two interfaces, IFluidHandle and IFluidHandleInternal.
Breaking Changes
Deprecated members of IFluidHandle are split off into new IFluidHandleInternal interface.
See included changeset for more details.
Reviewer Guidance
The review process is outlined on this wiki page.