Skip to content

Commit 52dbe53

Browse files
committed
chore: generate markdown docs from jsdocs
1 parent 7637e06 commit 52dbe53

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

docs/api/hooks/useActionData.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ title: useActionData
44

55
# useActionData
66

7+
<!--
8+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
9+
10+
Hey! Thank you for helping improve our documentation!
11+
12+
This file is auto-generated from the JSDoc comments in the source
13+
code, so please find the definition of this API and edit the JSDoc
14+
comments accordingly and this file will be re-generated once those
15+
changes are merged.
16+
-->
17+
718
[MODES: framework, data]
819

920
## Summary
@@ -35,5 +46,6 @@ export default function Invoices() {
3546
## Signature
3647

3748
```tsx
38-
useActionData(): undefined
49+
useActionData<T = any>(): SerializeFrom<T> | undefined
3950
```
51+

docs/api/hooks/useLoaderData.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,26 @@ title: useLoaderData
44

55
# useLoaderData
66

7+
<!--
8+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
9+
10+
Hey! Thank you for helping improve our documentation!
11+
12+
This file is auto-generated from the JSDoc comments in the source
13+
code, so please find the definition of this API and edit the JSDoc
14+
comments accordingly and this file will be re-generated once those
15+
changes are merged.
16+
-->
17+
718
[MODES: framework, data]
819

920
## Summary
1021

1122
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useLoaderData.html)
1223

13-
Returns the data from the closest route [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) or [ClientLoaderFunction](https://api.reactrouter.com/v7/types/react_router.ClientLoaderFunction.html).
24+
Returns the data from the closest route
25+
[`loader`](../../start/framework/route-module#loader) or
26+
[`clientLoader`](../../start/framework/route-module#clientloader).
1427

1528
```tsx
1629
import { useLoaderData } from "react-router";
@@ -28,5 +41,6 @@ export default function Invoices() {
2841
## Signature
2942

3043
```tsx
31-
useLoaderData(): SerializeFrom
44+
useLoaderData<T = any>(): SerializeFrom<T>
3245
```
46+

0 commit comments

Comments
 (0)