docs: clarify query vs prerender on prerendered pages#15408
Open
RazinShafayet2007 wants to merge 2 commits intosveltejs:mainfrom
Open
docs: clarify query vs prerender on prerendered pages#15408RazinShafayet2007 wants to merge 2 commits intosveltejs:mainfrom
query vs prerender on prerendered pages#15408RazinShafayet2007 wants to merge 2 commits intosveltejs:mainfrom
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
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.
Closes #15274
This PR clarifies the Remote Functions docs for prerendered pages (
export const prerender = true). It adds a note in thequerysection explaining thatqueryrequires a runtime server and can’t be used during prerendering (including whenprerender = trueis set on a parent+layout), and updates theprerendersection note to clarify thatprerenderfunctions do work on prerendered pages (including fully staticadapter-staticbuilds).Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits