Skip to content

docs: explain why route id can be null #13581

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

Merged
merged 3 commits into from
Mar 14, 2025

Conversation

sacrosanctic
Copy link
Contributor

@sacrosanctic sacrosanctic commented Mar 14, 2025

I couldn't get symlinks to work so I'm just winging it :/


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.

@benmccann
Copy link
Member

You've edited the generated file. You need to instead update src/exports/public.d.ts and then run pnpm generate:types

@@ -972,7 +972,7 @@ declare module '@sveltejs/kit' {
*/
route: {
/**
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`. It is null when the router fails to match a route.
Copy link
Member

Choose a reason for hiding this comment

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

I think we can tweak this to be a bit more concise and avoid the word "fails" which might indicate some error occurred rather than expected behavior

Suggested change
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`. It is null when the router fails to match a route.
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`. The ID is `null` when no route is matched.

@benmccann benmccann added the documentation Improvements or additions to documentation label Mar 14, 2025
Copy link

changeset-bot bot commented Mar 14, 2025

⚠️ No Changeset found

Latest commit: addd6b8

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

@svelte-docs-bot
Copy link

Copy link
Member

@Rich-Harris Rich-Harris left a comment

Choose a reason for hiding this comment

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

accepted ben's suggestion and applied the changes to public.d.ts. thanks!

@Rich-Harris Rich-Harris merged commit 6e4f3b9 into sveltejs:main Mar 14, 2025
15 checks passed
@sacrosanctic sacrosanctic deleted the tricky-chicken branch March 15, 2025 00:41
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.

3 participants