feat: Update InitialContext #184
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
InitialContext will always be available when run in a portal context with at least the name value defined. This now makes `getInitialContext` an indicator to the web developers whether or not their code is being executed inside of a Portal or not without the native team having to provide any initialContext if it is not needed. BREAKING CHANGE This is an API breaking change since InitialContext<T> was initially assumed to always have a value provided if it was present. This is now changed so that we always provide access to the name of the portal to the web code to avoid there being strong coupling to the name.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Steven0351
commented
Nov 7, 2022
| export function getInitialContext<T = unknown>(): InitialContext<T> | undefined { | ||
| return (window as any).portalInitialContext as { name: string, value: T; }; | ||
| return (window as any).portalInitialContext; |
There was a problem hiding this comment.
The explicit casting here is not needed and nothing happens at runtime if this isn't a valid cast anyway.
Steven0351
commented
Nov 7, 2022
plugin/src/web.ts
Outdated
| return { | ||
| subscriptionRef: -0, | ||
| topic: "" | ||
| } |
There was a problem hiding this comment.
returning null as any is kind of a jerk move, we should return something here that isn't going make this a PITA to work with if a web developer is using the API outside of a Portals context during development.
giralte-ionic
approved these changes
Nov 7, 2022
carlpoole
approved these changes
Nov 7, 2022
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.
feat: Make InitialContext.value T | undefined. This is to support that InitialContext will always be available when run in a portal context with at least the name value defined. This now makes
getInitialContextan indicator to the web developers whether or not their code is being executed inside of a Portal or not without the native team having to provide any initialContext if it is not needed.BREAKING CHANGE
This is an API breaking change since InitialContext was initially assumed to always have a value provided if it was present. This is now changed so that we always provide access to the name of the portal to the web code to avoid there being strong coupling to the name.