[chore] allow EndpointOutput response objects with toJSON property (#2170)

JeanJPNM · ignatiusmb · web-flow · commit ef2cf5d8bd08 · 2021-08-13T20:33:10.000+07:00
allows users to return objects with a custom toJSON property

Co-authored-by: Ignatius Bagus &lt;ignatius.mbs@gmail.com&gt;
diff --git a/.changeset/thirty-frogs-mix.md b/.changeset/thirty-frogs-mix.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+Allow `EndpointOutput` response body objects to have a `toJSON` property
diff --git a/packages/kit/types/endpoint.d.ts b/packages/kit/types/endpoint.d.ts
@@ -1,9 +1,18 @@
 import { ServerRequest } from './hooks';
 import { Headers, MaybePromise } from './helper';
 
-type JSONValue = string | number | boolean | null | JSONValue[] | { [key: string]: JSONValue };
+type ToJSON = { toJSON(...args: any[]): JSONValue };
+type JSONValue = Exclude<JSONResponse, ToJSON>;
+type JSONResponse =
+	| string
+	| number
+	| boolean
+	| null
+	| JSONResponse[]
+	| ToJSON
+	| { [key: string]: JSONResponse };
 
-type DefaultBody = JSONValue | Uint8Array;
+type DefaultBody = JSONResponse | Uint8Array;
 
 export interface EndpointOutput<Body extends DefaultBody = DefaultBody> {
 	status?: number;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@sveltejs/kit': patch
 +---
++
 +Allow `EndpointOutput` response body objects to have a `toJSON` property