Skip to content

Doc: missing RouteRecord type definiton  #2634

Open
@Fiouz

Description

@Fiouz

Version

3.0.2

Reproduction link

https://router.vuejs.org/api/

Steps to reproduce

  1. Read the API documentation at https://router.vuejs.org/api/#routes for the routes router construction options and see that the routes field is designated as an array of RouteConfig (with an accompanying definition of that type).
  2. Read the API documentation at https://router.vuejs.org/api/#route-object-properties for $route.matched and see that the copy of the aforementioned routes option is now designated as an array of RouteRecord (with not definition of that type)

What is expected?

If the latter is a copy of the former, it should be expected that it should be the same object type or that an explicit relationship between the 2 types be mentioned in the API doc as a canonical definition.

What is actually happening?

There is no canonical definition of what a RouteRecord type is, we only have an example that denotes the array of RouteConfig and we don't understand why copying a type does not result of an instance of the same type.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions