docs(@remix-run/react): jsdoc for SerializeFrom

remix-run · Aug 17, 2022 · 377512a · 377512a
1 parent fb5884d
commit 377512a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/remix-react/serialize.ts b/packages/remix-react/serialize.ts
@@ -62,6 +62,12 @@ export type TypedResponse<T extends unknown = unknown> = Response & {
 
 type ArbitraryFunction = (...args: any[]) => unknown;
 
+/**
+ * Infer JSON serialized data type returned by a loader or action.
+ *
+ * For example:
+ * `type LoaderData = SerializeFrom<typeof loader>`
+ */
 export type SerializeFrom<T extends AppData | ArbitraryFunction> = Serialize<
   T extends (...args: any[]) => infer Output
     ? Awaited<Output> extends TypedResponse<infer U>