Document LayoutParams, which differs from RouteParams

[hyunbinseo]

Describe the problem

Consider src/routes/[foo]/[bar]/[baz]/+page.svelte route.

In the src/routes/[foo]/[bar]/+layout.ts's load function,

• params.foo: string
• params.bar: string
• params.baz?: string | undefined

params.baz can be accessed, but it is not documented.

---

Current documentation.

// .svelte-kit/types/src/routes/[foo]/[bar]/[baz]/$types.d.ts

import type * as Kit from '@sveltejs/kit';
 
type RouteParams = {
  foo: string;
  bar: string;
  baz: string;
}
 
export type PageServerLoad = Kit.ServerLoad<RouteParams>;
export type PageLoad = Kit.Load<RouteParams>;

---

Demo - Consider the following project structure.

.
└── src/
    └── routes/
        └── [foo]/
            └── [bar]/
                ├── [baz]/
                │   └── +page.server.js
                └── +layout.server.js

The following types are generated by SvelteKit. (partially omitted)

// .svelte-kit/types/src/routes/[foo]/[bar]/[baz]/$types.d.ts

import type * as Kit from '@sveltejs/kit';

type RouteParams = { foo: string; bar: string; baz: string }

export type PageServerLoad = Kit.ServerLoad<RouteParams, PageServerParentData, OutputData, RouteId>;

// .svelte-kit/types/src/routes/[foo]/[bar]/$types.d.ts

import type * as Kit from '@sveltejs/kit';

type RouteParams = { foo: string; bar: string }
type LayoutParams = RouteParams & { foo?: string,bar?: string,baz?: string }
// type LayoutParams = { foo: string, bar: string, baz?: string | undefined }

export type LayoutServerLoad = Kit.ServerLoad<LayoutParams, LayoutServerParentData, OutputData, LayoutRouteId>;

Describe the proposed solution

Add documentations to

• https://kit.svelte.dev/docs/types#generated-types
• https://kit.svelte.dev/docs/load

Alternatives considered

No response

Importance

nice to have

Additional Information

No response

[hyunbinseo]

The Load / Using URL data / params documentation should be updated as well.

In the /a/[b]/+layout.ts file's load function: params.c?: string | undefined

---

params

params is derived from url.pathname and route.id.

Given a route.id of /a/[b]/[...c] and a url.pathname of /a/x/y/z, the params object would look like this:

{
	"b": "x",
	"c": "y/z"
}

[hyunbinseo]

Revisiting this issue, updating the params documentation seems sufficient:

- the `params` object would look like this:
+ the page `params` object would look like this:

// specify that this is the page's params object
{ "b": "x", "c": "y/z" }