vuejs/vue-router

The type definition of Route seems to be partially wrong

Open

#3,566 opened on Jun 9, 2021

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (5,092 forks)batch import
Typescriptcontribution welcomefixed on 4.xgood first issue

Repository metrics

Stars
 (19,015 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Version

3.5.1

Reproduction link

https://github.com/vuejs/vue-router/blob/dev/types/router.d.ts#L203

Steps to reproduce

None, just the source code seems to be wrong.

What is expected?

The type definition of Route#query should be

query: Dictionary<string | null | (string | null)[]>

The current implementation cannot express this type of query

/path?foo#bar

as it doesn't have any value and it is not converted to an array.

What is actually happening?

https://github.com/vuejs/vue-router/blob/dev/types/router.d.ts#L203

The type definition of Route#query is

query: Dictionary<string | (string | null)[]>

Contributor guide

Research direction
The issue points to a specific line in types/router.d.ts (line 203) where the Route#query type is defined as Dictionary<string | (string | null)[]>. The expected change is to include string | null as an option for the dictionary value, making it Dictionary<string | null | (string | null)[]>. This is a simple type correction. No discussion or PRs are linked. The fix should be applied to the same file.
Tech stack
typescriptvue
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic TypeScript understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85