types: separate out deprecated highlight overload
#3987
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
joshgoebel
approved these changes
Feb 20, 2024
Minor thing in the type definitions I noticed. The .js makes it clear that the old API looks like `highlight(lang, code, ignoreIllegals)`, and the new API looks like `highlight(code, {lang, ignoreIllegals})`.
The types on the other hand imply you could do things like `highlight(code, {lang: ...}, true)` - but that `true` would be ignored at runtime.
So this separates the two forms into function overloads, and adds a `/** @deprecated */` tag to the old form so IDEs will hint not to use it.
Build Size ReportChanges to minified artifacts in 5 files changedTotal change -112 B View Changes
|
Build Size ReportChanges to minified artifacts in 3 files changedTotal change +3 B View Changes
|
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.
Minor thing in the type definitions I noticed. The .js makes it clear that the old API looks like
highlight(lang, code, ignoreIllegals), and the new API looks likehighlight(code, {lang, ignoreIllegals}).The types on the other hand imply you could do things like
highlight(code, {lang: ...}, true)- but thattruewould be ignored at runtime.Changes
So this separates the two forms into function overloads, and adds a
/** @deprecated */tag to the old form so IDEs will hint not to use it.Checklist
CHANGES.md