Added more documentation for bool, char, and numeric types
#4245
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
daxpedda
approved these changes
Nov 7, 2024
Co-authored-by: daxpedda <daxpedda@gmail.com>
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.
A small PR where I added documentation for
bool,char, and the numeric types to explain how they are represented in JS and how the conversion between JS values and Rust values works. I also added some links and formatting to a few other pages.My goal was to answer all the questions I had about number conversions when I first used WBG. E.g. when I first used WBG, I thought that
u64would map to a JSnumberas well, since that's what the docs said: "JavaScript representation: A JavaScript number value". So I usedjs_sys::BigIntfor theu64in my project since I needed the full 64 bits and added some custom parsing logic to convertjs_sys::BigInt->u64. Clunky and unnecessary.Relates to #4222 and #4201, since both PRs need to update the docs from this PR.
This PR is technically independent of #4226, but I can combine the two if you like.