Typescript client: Support relative URLs in browser environments #3694
Conversation
This file contains hidden or 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
In browser contexts, ShapeStream now accepts relative URLs (e.g., `/v1/shape`) which are resolved against `window.location.origin`. This simplifies usage when the Electric server is hosted on the same origin as the web application. In non-browser environments, relative URLs throw a clear error explaining that an absolute URL is required.
fabianlindfors
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In browser contexts,
ShapeStreamnow accepts relative URLs (e.g.,/v1/shape) which are resolved againstwindow.location.origin. This simplifies usage when the proxy is hosted on the same origin as the web application (like would be common with Next.js). In non-browser context, the behaviour remains the same with the constructor throwing an error for relative URLs.Issue: #3693
Discord: https://discord.com/channels/933657521581858818/1065311523112763392/1460212637739778120