Rename meta types for consistency
#378
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
BREAKING CHANGE: Consumers will need to update their type imports. This renames `MetaDescriptor` to `HtmlMetaDescriptor` for better consistency with `HtmlLinkDescriptor`. `remix-server-runtime` also exposed a type `HTMLLinkDescriptor` with inconsistent casing, so I changed that as well.
chaance
commented
Nov 11, 2021
| [name: string]: string | string[]; | ||
| } | ||
|
|
||
| export type MetaDescriptor = HtmlMetaDescriptor; |
There was a problem hiding this comment.
This alias is for consistency with LinkDescriptor, even though HtmlMetaDescriptor will only ever be HtmlMetaDescriptor (probably). Gives us a little wiggle room if we ever change that.
chaance
requested review from
jacob-ebey and
mcansh
and removed request for
jacob-ebey and
mcansh
mcansh
approved these changes
Nov 11, 2021
sergiodxa
approved these changes
Nov 11, 2021
|
Sorry I screwed up your doc updates, want to fix the conflicts and then I'll merge :) |
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
kentcdodds
approved these changes
Nov 19, 2021
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.
BREAKING CHANGE: Consumers will need to update their type imports. This renames
MetaDescriptortoHtmlMetaDescriptorfor better consistency withHtmlLinkDescriptor.remix-server-runtimealso exposed a typeHTMLLinkDescriptorwith inconsistent casing, so I changed that as well.I've also exported both types from
@remix-run/reactdirectly which makes predictive imports in VS Code a little better IMO.