docs: sync up type documentation with implementation (sveltejs#1430)

andyburke-forks · May 25, 2021 · f1ea703 · f1ea703
1 parent 35c1108
commit f1ea703
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 22 deletions.
diff --git a/documentation/docs/01-routing.md b/documentation/docs/01-routing.md
@@ -48,27 +48,29 @@ A file or directory can have multiple dynamic parts, like `[id]-[category].svelt
 Endpoints are modules written in `.js` (or `.ts`) files that export functions corresponding to HTTP methods. For example, our hypothetical blog page, `/blog/cool-article`, might request data from `/blog/cool-article.json`, which could be represented by a `src/routes/blog/[slug].json.js` endpoint:
 
 ```ts
-type Request<Context = any> = {
+type Headers = Record<string, string>;
+
+type Request<Locals = Record<string, any>, Body = unknown> = {
+	method: string;
 	host: string;
-	method: 'GET';
-	headers: Record<string, string>;
+	headers: Headers;
 	path: string;
-	params: Record<string, string | string[]>;
+	params: Record<string, string>;
 	query: URLSearchParams;
 	rawBody: string | Uint8Array;
-	body: string | Uint8Array | JSONValue;
-	locals: Record<string, any>; // see below
+	body: ParameterizedBody<Body>;
+	locals: Locals; // populated by hooks handle
 };
 
-type Response = {
+type EndpointOutput = {
 	status?: number;
-	headers?: Record<string, string>;
-	body?: any;
+	headers?: Headers;
+	body?: string | Uint8Array | JSONValue;
 };
 
-type RequestHandler<Context = any> = {
-	(request: Request<Context>) => Response | Promise<Response>;
-}
+type RequestHandler<Locals = Record<string, any>> = (
+	request: Request<Locals>
+) => void | EndpointOutput | Promise<EndpointOutput>;
 ```
 
 ```js

diff --git a/documentation/docs/03-loading.md b/documentation/docs/03-loading.md
@@ -11,7 +11,7 @@ type LoadInput = {
 	page: {
 		host: string;
 		path: string;
-		params: Record<string, string | string[]>;
+		params: Record<string, string>;
 		query: URLSearchParams;
 	};
 	fetch: (info: RequestInfo, init?: RequestInit) => Promise<Response>;
@@ -21,7 +21,7 @@ type LoadInput = {
 
 type LoadOutput = {
 	status?: number;
-	error?: Error;
+	error?: string | Error;
 	redirect?: string;
 	props?: Record<string, any>;
 	context?: Record<string, any>;

diff --git a/documentation/docs/04-hooks.md b/documentation/docs/04-hooks.md
@@ -15,6 +15,8 @@ If unimplemented, defaults to `({ request, render }) => render(request)`.
 To add custom data to the request, which is passed to endpoints, populate the `request.locals` object, as shown below.
 
 ```ts
+type Headers = Record<string, string>;
+
 type Request<Locals = Record<string, any>> = {
 	method: string;
 	host: string;
@@ -23,19 +25,19 @@ type Request<Locals = Record<string, any>> = {
 	params: Record<string, string>;
 	query: URLSearchParams;
 	rawBody: string | Uint8Array;
-	body: string | Uint8Array | ReadOnlyFormData | JSONValue;
-	locals: Locals;
+	body: ParameterizedBody<Body>;
+	locals: Locals; // populated by hooks handle
 };
 
 type Response = {
-	status?: number;
-	headers?: Headers;
-	body?: any;
+	status: number;
+	headers: Headers;
+	body?: string | Uint8Array;
 };
 
-type Handle<Locals = Record<string, any>> = ({
-	request: Request<Locals>,
-	render: (request: Request<Locals>) => Promise<Response>
+type Handle<Locals = Record<string, any>> = (input: {
+	request: Request<Locals>;
+	render: (request: Request<Locals>) => Response | Promise<Response>;
 }) => Response | Promise<Response>;
 ```