Skip to content

[docs] Clarify usage of page.query#2910

Merged
Rich-Harris merged 3 commits into
sveltejs:masterfrom
adriandelgado:doc-clarification
Nov 25, 2021
Merged

[docs] Clarify usage of page.query#2910
Rich-Harris merged 3 commits into
sveltejs:masterfrom
adriandelgado:doc-clarification

Conversation

@adriandelgado

@adriandelgado adriandelgado commented Nov 25, 2021

Copy link
Copy Markdown
Contributor

This PR clarifies the usage of page.query. Currently if you use it in a prerendered page it throws an error unless you use it in a browser/client context only. These behavior is undocumented and people have asked related questions before #2262 #669

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot

changeset-bot Bot commented Nov 25, 2021 •
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2ed1013

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@bluwy bluwy added the documentation Improvements or additions to documentation label Nov 25, 2021
Rich-Harris
Rich-Harris approved these changes Nov 25, 2021
View reviewed changes
Comment thread documentation/docs/03-loading.md Outdated
Comment thread documentation/docs/11-ssr-and-javascript.md Outdated
@Rich-Harris Rich-Harris merged commit cf3a8b5 into sveltejs:master Nov 25, 2021
@Rich-Harris

Rich-Harris commented Nov 25, 2021

Copy link
Copy Markdown
Member

thank you!

@adriandelgado adriandelgado deleted the doc-clarification branch November 25, 2021 15:15
@snyk-bot snyk-bot mentioned this pull request Apr 1, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Rich-Harris Rich-Harris Rich-Harris approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@adriandelgado @Rich-Harris @bluwy