Fix encode, decode and uuid docs examples #929
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
mtuchi
reviewed
Jan 23, 2025
| @@ -40,12 +40,12 @@ export const encode = (data, options = { parseJson: true }) => { | |||
| * @param {object} options - Options. | |||
There was a problem hiding this comment.
Can we add what options we support, Something like this i guess
* @param {boolean} [options.parseJson=true] - Whether to parse the decoded string as JSON.
mtuchi
reviewed
Jan 23, 2025
packages/common/src/util/base64.js
Outdated
| @@ -9,13 +9,13 @@ import _ from 'lodash'; | |||
| * @param {object} options - Options. | |||
There was a problem hiding this comment.
* @param {boolean} [options.parseJson=true] - Whether to parse the encoded string as JSON.
There was a problem hiding this comment.
Agreed - thanks!
mtuchi
reviewed
Jan 23, 2025
There was a problem hiding this comment.
The docs looks good @josephjclark
Just a tiny suggestion, can we document the supported option.
Something like this
* @param {boolean} [options.parseJson=true] - Whether to parse the decoded string as JSON.If your happy with the language i can push the changes on this branch
|
I am patching common but not updating other adaptors. I think this will be OK |
|
hmm. That's caused a weird package lock diff because common is unlinked. Not sure I understand this. Since this is a docs only change, I'll revert and remove the version bump. Leaving the history because I want to keep a record of that fail |
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.
Summary
Namespaces are missing in these examples!
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy