[FEAT]: adding meta field to @magic-sdk magic constructor #708
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
hcote
approved these changes
Feb 9, 2024
Ethella
reviewed
Feb 9, 2024
| @@ -118,6 +118,7 @@ export interface MagicSDKAdditionalConfiguration< | |||
| testMode?: boolean; | |||
| deferPreload?: boolean; | |||
| useStorageCache?: boolean; | |||
| meta?: any; // Generic field for clients to add metadata | |||
There was a problem hiding this comment.
Could you provide an example of well-structured metadata that our client, WC, has previously submitted? I'm interested in understanding the standards and quality they adhere to.
There was a problem hiding this comment.
They'll be submitting something like this:
meta: {
projectId: "abcd123"
}
There was a problem hiding this comment.
But the idea is that the meta field is unopinionated, so that any client can put identifying info in there to reference in event logs later on. They could for example put in their internal user ID, or classification tags.
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.
📦 Pull Request
Adding a meta field to the Magic constructor in the @magic-sdk package to allow arbitrary data to be sent to the Magic backend. Ping @bengriffin1 for more details.
✅ Fixed Issues
n/a
🚨 Test instructions
No test needed as of now
Please only add one label:
patch: Bug Fix?minor: New Feature?major: Breaking Change?skip-release: It's unnecessary to publish this change.📦 Published PR as canary version:
Canary Versions✨ Test out this PR locally via: