Add RFC9285 base45 support and more options. #15
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
- Add RFC9285 base45 support for more efficient encoding than base32.
- Defaulting to base32 until the next major release.
- More `toQrCode` options available:
- `qrMultibaseEncoding`: Encoding for QR data. `B` for base32, `R` for
base45. base45 is more efficient. Defaults to base32.
- `qrErrorCorrectionLevel`: Error correction level used in the QR
code. 'L' Low 7%, 'M' Medium 15%, 'Q' Qartile 25%, 'H' High 30%.
Defaults to 'L'.
- `qrVersion`: QR version. 1-40 or 0 for auto. Defaults to auto.
davidlehn
force-pushed
the
add-base45-and-options
branch
from
5401da9
to
4a65669
Compare
dlongley
approved these changes
Jun 22, 2024
Comment on lines
+116
to
+120
| - `qrMultibaseEncoding`: Encoding for QR data. `B` for [RFC4648][] base32, `R` | ||
| for [RFC9285][] base45. base45 is more efficient. Defaults to base32. | ||
| - `qrErrorCorrectionLevel`: Error correction level used in the QR code. 'L' Low | ||
| 7%, 'M' Medium 15%, 'Q' Qartile 25%, 'H' High 30%. Defaults to 'L'. | ||
| - `qrVersion`: QR version. 1-40 or 0 for auto. Defaults to auto. |
There was a problem hiding this comment.
Another way to do this would be under the options.qr namespace (e.g., options.qr.multibaseEncoding, ...). I'm ok with either.
There was a problem hiding this comment.
Suffering analysis paralysis with this and differences in libraries and use cases. Going to go with something for now and will adjust in major releases later as needed and experience is gained.
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.
toQrCodeoptions available:qrMultibaseEncoding: Encoding for QR data.Bfor base32,Rfor base45. base45 is more efficient. Defaults to base32.qrErrorCorrectionLevel: Error correction level used in the QR code. 'L' Low 7%, 'M' Medium 15%, 'Q' Qartile 25%, 'H' High 30%. Defaults to 'L'.qrVersion: QR version. 1-40 or 0 for auto. Defaults to auto.