Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mention the building variable to execute non-prerenderable code in server handle #13153

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eltigerchino
Copy link
Member

closes #9965

Adds a note that the building variable should be used to check that the app isn't building before executing some code only available when not prerendering or building.


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 pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Dec 12, 2024
Copy link

changeset-bot bot commented Dec 12, 2024

⚠️ No Changeset found

Latest commit: 6affa8b

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

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13153-svelte.vercel.app/

this is an automated message

@@ -39,6 +39,8 @@ export async function handle({ event, resolve }) {
If unimplemented, defaults to `({ event, resolve }) => resolve(event)`.

If you need to exclude some code from running during the build or prerendering step, check that the app is not [`building`]($app-environment#building) beforehand.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this suffices - the confusion is also about why handle even is executed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you need to exclude some code from running during the build or prerendering step, check that the app is not [`building`]($app-environment#building) beforehand.
The `handle` hook is invoked each time a route is requested during prerendering. If you need to exclude some code from running during this phase, check that the app is not [`building`]($app-environment#building) beforehand.

Does this preceding sentence help answer that question?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite - the question is also "why is that route even requested during prerendering, I did export const prerender = false"

Copy link
Member Author

@eltigerchino eltigerchino Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about mentioning the crawler? It's true that it crawls both prerendered and non-prerendered pages.

Suggested change
If you need to exclude some code from running during the build or prerendering step, check that the app is not [`building`]($app-environment#building) beforehand.
During prerendering, SvelteKit crawls your pages for links and invokes the `handle` hook for each route it finds. If you need to exclude some code from running during this phase, check that the app is not [`building`]($app-environment#building) beforehand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

prerender when using hooks.server.js
3 participants