Skip to content

Commit f5183b8

Browse files
brilloutCopilot
andcommitted
[AI] Add JSDocs with links to ReactOptions props
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 02c60b9 commit f5183b8

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

packages/vike-react/src/types/Config.ts

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,10 +300,27 @@ export type ConfigViaHook = PickWithoutGetter<
300300
export type ConfigViaHookResolved = Omit<ConfigViaHook, ConfigsCumulative> &
301301
Pick<Vike.ConfigResolved, ConfigsCumulative>
302302

303-
// TODO/ai add JSDocs with links to each prop
304303
export type ReactOptions = {
304+
/**
305+
* Options passed to React's `hydrateRoot()`.
306+
*
307+
* https://react.dev/reference/react-dom/client/hydrateRoot
308+
* https://vike.dev/react-setting
309+
*/
305310
hydrateRootOptions?: HydrationOptions
311+
/**
312+
* Options passed to React's `createRoot()`.
313+
*
314+
* https://react.dev/reference/react-dom/client/createRoot
315+
* https://vike.dev/react-setting
316+
*/
306317
createRootOptions?: RootOptions
318+
/**
319+
* Options passed to React's `renderToString()`.
320+
*
321+
* https://react.dev/reference/react-dom/server/renderToString
322+
* https://vike.dev/react-setting
323+
*/
307324
renderToStringOptions?: ServerOptions
308325
/**
309326
* Options passed to `react-streaming`'s `renderToStream()` during SSR streaming.

0 commit comments

Comments
 (0)