Skip to content

refactor(router-core): decorate with JSDoc for NavigateOptionProps, ActiveOptions, MatchRouteOptions and Redirect #3792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 16, 2025
Merged

refactor(router-core): decorate with JSDoc for NavigateOptionProps, ActiveOptions, MatchRouteOptions and Redirect #3792

merged 2 commits into from
Mar 16, 2025

Conversation

@Thiht
Copy link
Contributor

@Thiht Thiht commented Mar 16, 2025

Hi,
Following up on #3790 I added some JSDoc on a few uncommented types I encountered in my project

I basically copied the text & default from the documentation except for hashScrollIntoView and viewTransition where the existing non-JSDoc comments seem good

@nx-cloud
Copy link

nx-cloud bot commented Mar 16, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 6c2bc34.

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

☁️ Nx Cloud last updated this comment at 2025-03-16 23:12:37 UTC

@SeanCassiere SeanCassiere changed the title docs: add jsdoc to types NavigateOptionProps, ActiveOptions, MatchRouteOptions and Redirect refactor(router-core): decorate with JSDoc for NavigateOptionProps, ActiveOptions, MatchRouteOptions and Redirect Mar 16, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 16, 2025

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@3792

@tanstack/create-router

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

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@3792

@tanstack/create-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/create-start@3792

@tanstack/eslint-plugin-router

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

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@3792

@tanstack/react-router

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

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@3792

@tanstack/react-router-with-query

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

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@3792

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@3792

@tanstack/react-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-config@3792

@tanstack/react-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@3792

@tanstack/react-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-router-manifest@3792

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@3792

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@3792

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@3792

@tanstack/solid-router

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

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@3792

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@3792

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@3792

@tanstack/solid-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-config@3792

@tanstack/solid-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@3792

@tanstack/solid-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-router-manifest@3792

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@3792

@tanstack/start

npm i https://pkg.pr.new/TanStack/router/@tanstack/start@3792

@tanstack/start-api-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-api-routes@3792

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@3792

@tanstack/start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-config@3792

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@3792

@tanstack/start-server-functions-client

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

@tanstack/start-server-functions-fetcher

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

@tanstack/start-server-functions-handler

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

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@3792

@tanstack/start-server-functions-ssr

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

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@3792

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@3792

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@3792

commit: 6c2bc34

@SeanCassiere
Copy link
Member

SeanCassiere commented Mar 16, 2025

@Thiht thank you for taking the time to contribute this! Much appreciated 🙌🏼

@SeanCassiere SeanCassiere merged commit 6ad6ee1 into TanStack:main Mar 16, 2025
5 checks passed
leesb971204 pushed a commit to leesb971204/router that referenced this pull request Apr 16, 2025
@Thiht @autofix-ci @leesb971204
refactor(router-core): decorate with JSDoc comments for `NavigateOpti…
b1cb782 
…onProps`, `ActiveOptions`, `MatchRouteOptions` and `Redirect` (TanStack#3792)

Following up on TanStack#3790 I added some JSDoc on a few uncommented types I encountered in my project.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SeanCassiere SeanCassiere SeanCassiere approved these changes

Assignees

No one assigned

Labels

package: router-core

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Thiht @SeanCassiere