Skip to content

Commit 18d69fb

Browse files
authored
docs: mention page state (#13348)
1 parent 702575e commit 18d69fb

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

packages/kit/src/exports/public.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,31 +1088,31 @@ export interface AfterNavigate extends Omit<Navigation, 'type'> {
10881088
}
10891089

10901090
/**
1091-
* The shape of the `$page` store
1091+
* The shape of the [`page`](https://svelte.dev/docs/kit/$app-state#page) reactive object and the [`$page`](https://svelte.dev/docs/kit/$app-stores) store.
10921092
*/
10931093
export interface Page<
10941094
Params extends Record<string, string> = Record<string, string>,
10951095
RouteId extends string | null = string | null
10961096
> {
10971097
/**
1098-
* The URL of the current page
1098+
* The URL of the current page.
10991099
*/
11001100
url: URL;
11011101
/**
1102-
* The parameters of the current page - e.g. for a route like `/blog/[slug]`, a `{ slug: string }` object
1102+
* The parameters of the current page - e.g. for a route like `/blog/[slug]`, a `{ slug: string }` object.
11031103
*/
11041104
params: Params;
11051105
/**
1106-
* Info about the current route
1106+
* Info about the current route.
11071107
*/
11081108
route: {
11091109
/**
1110-
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`
1110+
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`.
11111111
*/
11121112
id: RouteId;
11131113
};
11141114
/**
1115-
* Http status code of the current page
1115+
* HTTP status code of the current page.
11161116
*/
11171117
status: number;
11181118
/**

packages/kit/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,31 +1070,31 @@ declare module '@sveltejs/kit' {
10701070
}
10711071

10721072
/**
1073-
* The shape of the `$page` store
1073+
* The shape of the [`page`](https://svelte.dev/docs/kit/$app-state#page) reactive object and the [`$page`](https://svelte.dev/docs/kit/$app-stores) store.
10741074
*/
10751075
export interface Page<
10761076
Params extends Record<string, string> = Record<string, string>,
10771077
RouteId extends string | null = string | null
10781078
> {
10791079
/**
1080-
* The URL of the current page
1080+
* The URL of the current page.
10811081
*/
10821082
url: URL;
10831083
/**
1084-
* The parameters of the current page - e.g. for a route like `/blog/[slug]`, a `{ slug: string }` object
1084+
* The parameters of the current page - e.g. for a route like `/blog/[slug]`, a `{ slug: string }` object.
10851085
*/
10861086
params: Params;
10871087
/**
1088-
* Info about the current route
1088+
* Info about the current route.
10891089
*/
10901090
route: {
10911091
/**
1092-
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`
1092+
* The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`.
10931093
*/
10941094
id: RouteId;
10951095
};
10961096
/**
1097-
* Http status code of the current page
1097+
* HTTP status code of the current page.
10981098
*/
10991099
status: number;
11001100
/**

0 commit comments

Comments
 (0)