fix: throw error when using defineOgImage*
fns client-side
#293
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.
π Linked issue
#286
β Type of change
π Description
For users who don't quite understand the magic of Nuxt SSR or how OG Image tags need to work, it's quite easy to use the
defineOgImage*
composables in a way where no image is generated.This appears when users try to call these functions client-side only, as either we'll be inserting the
og:image
payload too late for Nuxt OG Image to generate the image or inserting the tags too late for any bots to pick them up.Previously no warning was shown and it would silently fail in these instances, this was because we were tree-shaking these composables out client-side.
This PR changes it so we avoid tree-shaking them in development, allowing us to show an error message that can be debugged.
βοΈ Correct Usage
β Incorrect Usage