Added jsdoc and docs for RouterOptions

[ducin]

Originates in #3529 (reply in thread)

content:

• Added jsdoc for multiple UpdatableRouteOptions params.
• Added preloading doc for GC time.

Moreover, the preload param in UpdatableRouteOptions is invalid (bug?, see: #3526) and I added @todo, as it might be easy to forget it. Not sure what is the recommended approach here though.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit dbcaf17.

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	4m 52s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	1m 27s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-02-23 15:56:31 UTC

[pkg-pr-new]

Open in Stackblitz

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-file-based-codesplitting
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• router-mono-simple-lazy
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-rsc
• tanstack-start-example-basic-static
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-example-large
• tanstack-start-example-supabase-basic
• tanstack-start-example-trellaux
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query
• tanstack-router-solid-example-solid-query
• tanstack-router-solid-example-kitchen-sink-file-based

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3537

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3537

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3537

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3537

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3537

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3537

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3537

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3537

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3537

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3537

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3537

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3537

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3537

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3537

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3537

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3537

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3537

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3537

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3537

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3537

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3537

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3537

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3537

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3537

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3537

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3537

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3537

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3537

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3537

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3537

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3537

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3537

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3537

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3537

commit: dbcaf17