TanStack / TanStack/router

ActiveOptions default is incorrect between LinkOptionsProps.activeOptions and the actual type

Open
#5,775 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15.1k
Forks
1.9k
Avg merge
1d 20h
Merged PRs (30d)
143

Description

The below line @default line mentions the default for link is the following:

https://github.com/TanStack/router/blob/854a7ef23dcd7b986af32e4efbb91861af58b9ca/packages/router-core/src/link.ts#L666

when looking at ActiveOptions it shows a difference in the defaults, the above default also can't be found in the code for the link either.

https://github.com/TanStack/router/blob/854a7ef23dcd7b986af32e4efbb91861af58b9ca/packages/router-core/src/link.ts#L635-L657

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open packages/router-core/src/link.ts and compare the @default line near line 666 with the ActiveOptions definition around lines 635-657. Confirm which default is represented by the actual type and update the link documentation so the stated default matches the code.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.