Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(ts): Update bundle.meta typings [IQQ-2105] #922

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

tkcranny
Copy link
Collaborator

@tkcranny tkcranny commented Nov 21, 2024

This updates the bundle.meta types with clearer docs, deprecation markings, and support for the new timezone and withSearch fields.

I've followed the Core Docs on this subject, but if anything is not strictly correct with the platform's behaviour I'll be happy to adjust.

  • Deprecated meta.zap, and all of the inner id, user, and user.timezone properties
  • Deprecated isTestingAuth, because the docs say "Legacy property".
  • Added withSearch: string | undefined. Docs unclear if this is always set and will be string | undefined, or if the key is present it will be a valid string, meaning withSearch?: string would be better.
  • Added timezone: string | null. Same as above.
  • isBulkRead: Unchanged, but curious if it should be marked deprecated or internal only too.

@tkcranny tkcranny requested a review from a team as a code owner November 21, 2024 03:33
Co-authored-by: Kola Erinoso <[email protected]>
Copy link
Contributor

@kreddlear kreddlear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkcranny looks good! If you're curious, looks like for timezone, it always exists but can be None, based on this code, so your existing code is correct 👍 (as compared with withSearch)

@kreddlear kreddlear merged commit eb89dcf into main Nov 22, 2024
14 checks passed
@kreddlear kreddlear deleted the IQQ-2105-bundle-meta-types branch November 22, 2024 00:47
@kola-er kola-er mentioned this pull request Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants