Merge pull request #435 from kitbagjs/update-props-documentation

kitbagjs · Jan 23, 2025 · dfbb6ec · dfbb6ec
2 parents a6e72c3 + 36a96b0
commit dfbb6ec
Show file tree

Hide file tree

Showing 25 changed files with 431 additions and 212 deletions.
diff --git a/docs/api/compositions/useLink.md b/docs/api/compositions/useLink.md
@@ -66,7 +66,7 @@ for navigating.
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `resolvedRoute` | `MaybeRefOrGetter`\< \| `undefined` \| `Readonly`\<\{ `hash`: `string`; `href`: [`Url`](../types/Url.md); `id`: `string`; `matched`: `CreateRouteOptionsMatched`\<`string`\>; `matches`: `CreateRouteOptionsMatched`\<`undefined` \| `string`\>[]; `name`: `string`; `params`: \{\}; `query`: `URLSearchParams`; `state`: \{\}; \}\>\> | - |
+| `resolvedRoute` | `MaybeRefOrGetter`\< \| `undefined` \| `Readonly`\<\{ `hash`: `string`; `href`: [`Url`](../types/Url.md); `id`: `string`; `matched`: [`CreatedRouteOptions`](../types/CreatedRouteOptions.md); `matches`: [`CreatedRouteOptions`](../types/CreatedRouteOptions.md)[]; `name`: `string`; `params`: \{\}; `query`: `URLSearchParams`; `state`: \{\}; \}\>\> | - |
 | `options`? | `MaybeRefOrGetter`\<[`UseLinkOptions`](../types/UseLinkOptions.md)\> | RouterResolveOptions Same options as router resolve. |
 
 ### Returns
@@ -92,7 +92,7 @@ for navigating.
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `source` | `MaybeRefOrGetter`\< \| `undefined` \| `string` \| `Readonly`\<\{ `hash`: `string`; `href`: [`Url`](../types/Url.md); `id`: `string`; `matched`: `CreateRouteOptionsMatched`\<`string`\>; `matches`: `CreateRouteOptionsMatched`\<`undefined` \| `string`\>[]; `name`: `string`; `params`: \{\}; `query`: `URLSearchParams`; `state`: \{\}; \}\>\> | The name of the route or a valid URL. |
+| `source` | `MaybeRefOrGetter`\< \| `undefined` \| `string` \| `Readonly`\<\{ `hash`: `string`; `href`: [`Url`](../types/Url.md); `id`: `string`; `matched`: [`CreatedRouteOptions`](../types/CreatedRouteOptions.md); `matches`: [`CreatedRouteOptions`](../types/CreatedRouteOptions.md)[]; `name`: `string`; `params`: \{\}; `query`: `URLSearchParams`; `state`: \{\}; \}\>\> | The name of the route or a valid URL. |
 | `paramsOrOptions`? | `MaybeRefOrGetter`\< \| `Record`\<`PropertyKey`, `unknown`\> \| [`UseLinkOptions`](../types/UseLinkOptions.md)\> | - |
 | `maybeOptions`? | `MaybeRefOrGetter`\<[`UseLinkOptions`](../types/UseLinkOptions.md)\> | - |
 

diff --git a/docs/api/functions/createExternalRoute.md b/docs/api/functions/createExternalRoute.md
@@ -21,7 +21,7 @@ function createExternalRoute<THost, TName, TPath, TQuery, THash, TMeta>(options)
 
 | Parameter | Type |
 | ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>\> & `WithHost`\<`THost`\> & `WithoutParent` |
+| `options` | [`WithHooks`](../types/WithHooks.md) & `object` & `WithHost`\<`THost`\> & `WithoutParent` |
 
 ### Returns
 
@@ -37,7 +37,7 @@ function createExternalRoute<TParent, TName, TPath, TQuery, THash, TMeta>(option
 
 | Type Parameter | Default type |
 | ------ | ------ |
-| `TParent` *extends* [`Route`](../types/Route.md)\<`string`, `Host`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>, `Record`\<`string`, [`Param`](../types/Param.md)\>, `undefined` \| `string`\> | - |
+| `TParent` *extends* [`Route`](../types/Route.md)\<`string`, `Host`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>, `Record`\<`string`, [`Param`](../types/Param.md)\>, [`CreatedRouteOptions`](../types/CreatedRouteOptions.md)[]\> | - |
 | `TName` *extends* `undefined` \| `string` | `undefined` |
 | `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
 | `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
@@ -48,7 +48,7 @@ function createExternalRoute<TParent, TName, TPath, TQuery, THash, TMeta>(option
 
 | Parameter | Type |
 | ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>\> & `WithoutHost` & `WithParent`\<`TParent`\> |
+| `options` | [`WithHooks`](../types/WithHooks.md) & `object` & `WithoutHost` & `WithParent`\<`TParent`\> |
 
 ### Returns
 

diff --git a/docs/api/functions/createRoute.md b/docs/api/functions/createRoute.md
@@ -1,170 +1,23 @@
 # Functions: createRoute()
 
-## Call Signature
-
-```ts
-function createRoute<TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, ToPath<TPath>, ToQuery<TQuery>, ToHash<THash>, TMeta, TState, TName>
-```
-
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithoutComponents & (WithoutParent & (WithState\<TState\> \| WithoutState)) |
-
-### Returns
-
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `ToPath`\<`TPath`\>, `ToQuery`\<`TQuery`\>, `ToHash`\<`THash`\>, `TMeta`, `TState`, `TName`\>
-
-## Call Signature
-
-```ts
-function createRoute<TParent, TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, CombinePath<TParent["path"], ToPath<TPath>>, CombineQuery<TParent["query"], ToQuery<TQuery>>, CombineHash<TParent["hash"], ToHash<THash>>, CombineMeta<TMeta, TParent["meta"]>, CombineState<TState, TParent["state"]>, TName | TParent["matches"][number]["name"]>
-```
-
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TParent` *extends* [`Route`](../types/Route.md)\<`string`, `Host`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>, `Record`\<`string`, [`Param`](../types/Param.md)\>, `undefined` \| `string`\> | - |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithoutComponents & (WithParent\<TParent\> & (WithoutState \| WithState\<TState\>)) |
-
-### Returns
-
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `CombinePath`\<`TParent`\[`"path"`\], `ToPath`\<`TPath`\>\>, `CombineQuery`\<`TParent`\[`"query"`\], `ToQuery`\<`TQuery`\>\>, `CombineHash`\<`TParent`\[`"hash"`\], `ToHash`\<`THash`\>\>, `CombineMeta`\<`TMeta`, `TParent`\[`"meta"`\]\>, `CombineState`\<`TState`, `TParent`\[`"state"`\]\>, `TName` \| `TParent`\[`"matches"`\]\[`number`\]\[`"name"`\]\>
-
-## Call Signature
-
 ```ts
-function createRoute<TComponent, TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, ToPath<TPath>, ToQuery<TQuery>, ToHash<THash>, TMeta, TState, TName>
+function createRoute<TOptions, TProps>(options, ...args): ToRoute<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>
 ```
 
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TComponent` *extends* `Component` | - |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithComponent\<TComponent, Route\<ToName\<TName\>, Host\<"", \{\}\>, ToPath\<TPath\>, ToQuery\<TQuery\>, ToHash\<THash\>, TMeta, TState, TName\>\> & (WithoutParent & (WithoutState \| WithState\<...\>)) |
-
-### Returns
+## Type Parameters
 
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `ToPath`\<`TPath`\>, `ToQuery`\<`TQuery`\>, `ToHash`\<`THash`\>, `TMeta`, `TState`, `TName`\>
-
-## Call Signature
-
-```ts
-function createRoute<TComponent, TParent, TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, CombinePath<TParent["path"], ToPath<TPath>>, CombineQuery<TParent["query"], ToQuery<TQuery>>, CombineHash<TParent["hash"], ToHash<THash>>, CombineMeta<TMeta, TParent["meta"]>, CombineState<TState, TParent["state"]>, TName | TParent["matches"][number]["name"]>
-```
-
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TComponent` *extends* `Component` | - |
-| `TParent` *extends* [`Route`](../types/Route.md)\<`string`, `Host`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>, `Record`\<`string`, [`Param`](../types/Param.md)\>, `undefined` \| `string`\> | - |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithComponent\<TComponent, Route\<ToName\<TName\>, Host\<"", \{\}\>, CombinePath\<TParent\["path"\], ToPath\<TPath\>\>, CombineQuery\<...\>, CombineHash\<...\>, CombineMeta\<...\>, CombineState\<...\>, TName \| TParent\["matches"\]\[number\]\["name"\]\>\> & (WithParent\<...\> & (WithoutState \| WithState\<...\>)) |
-
-### Returns
-
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `CombinePath`\<`TParent`\[`"path"`\], `ToPath`\<`TPath`\>\>, `CombineQuery`\<`TParent`\[`"query"`\], `ToQuery`\<`TQuery`\>\>, `CombineHash`\<`TParent`\[`"hash"`\], `ToHash`\<`THash`\>\>, `CombineMeta`\<`TMeta`, `TParent`\[`"meta"`\]\>, `CombineState`\<`TState`, `TParent`\[`"state"`\]\>, `TName` \| `TParent`\[`"matches"`\]\[`number`\]\[`"name"`\]\>
-
-## Call Signature
-
-```ts
-function createRoute<TComponents, TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, ToPath<TPath>, ToQuery<TQuery>, ToHash<THash>, TMeta, TState, TName>
-```
-
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TComponents` *extends* `Record`\<`string`, `Component`\> | - |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithComponents\<TComponents, Route\<ToName\<TName\>, Host\<"", \{\}\>, ToPath\<TPath\>, ToQuery\<TQuery\>, ToHash\<THash\>, TMeta, TState, TName\>\> & (WithoutParent & (WithoutState \| WithState\<...\>)) |
-
-### Returns
-
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `ToPath`\<`TPath`\>, `ToQuery`\<`TQuery`\>, `ToHash`\<`THash`\>, `TMeta`, `TState`, `TName`\>
-
-## Call Signature
-
-```ts
-function createRoute<TComponents, TParent, TName, TPath, TQuery, THash, TMeta, TState>(options): Route<ToName<TName>, Host<"", {}>, CombinePath<TParent["path"], ToPath<TPath>>, CombineQuery<TParent["query"], ToQuery<TQuery>>, CombineHash<TParent["hash"], ToHash<THash>>, CombineMeta<TMeta, TParent["meta"]>, CombineState<TState, TParent["state"]>, TName | TParent["matches"][number]["name"]>
-```
-
-### Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TComponents` *extends* `Record`\<`string`, `Component`\> | - |
-| `TParent` *extends* [`Route`](../types/Route.md)\<`string`, `Host`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>, `Record`\<`string`, [`Param`](../types/Param.md)\>, `undefined` \| `string`\> | - |
-| `TName` *extends* `undefined` \| `string` | `undefined` |
-| `TPath` *extends* \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `TQuery` *extends* \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\> | `undefined` |
-| `THash` *extends* `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\> | `undefined` |
-| `TMeta` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `TState` *extends* `Record`\<`string`, [`Param`](../types/Param.md)\> | `Record`\<`string`, [`Param`](../types/Param.md)\> |
+| Type Parameter |
+| ------ |
+| `TOptions` *extends* [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`undefined` \| `string`, \| `undefined` \| `string` \| `Path`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, \| `undefined` \| `string` \| `Query`\<`string`, `Record`\<`string`, `undefined` \| [`Param`](../types/Param.md)\>\>, `undefined` \| `string` \| `Hash`\<`undefined` \| `string`\>, `Record`\<`string`, `unknown`\>\> |
+| `TProps` *extends* \| `PropsGetter`\<`TOptions`, `any`\[`any`\]\> \| `RoutePropsRecord`\<`TOptions`, `any`\[`any`\]\> \| `PropsGetter`\<`TOptions`, `__VLS_WithTemplateSlots`\<`DefineComponent`\<\{ `name`: `string`; \}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, \{\}, `string`, `PublicProps`, `Readonly`\<\{ `name`: `string`; \}\> & `Readonly`\<\{\}\>, \{\}, \{\}, \{\}, \{\}, `string`, `ComponentProvideOptions`, `false`, \{\}, `any`\>, `Readonly`\<\{ `default`: (`props`) => `VNode`; \}\> & `object`\>\> |
 
-### Parameters
+## Parameters
 
 | Parameter | Type |
 | ------ | ------ |
-| `options` | [`CreateRouteOptions`](../types/CreateRouteOptions.md)\<`TName`, `TPath`, `TQuery`, `THash`, `TMeta`\> & `WithHooks` & WithComponents\<TComponents, Route\<ToName\<TName\>, Host\<"", \{\}\>, CombinePath\<TParent\["path"\], ToPath\<TPath\>\>, ... 4 more ..., TName \| TParent\["matches"\]\[number\]\["name"\]\>\> & (WithParent\<...\> & (WithoutState \| WithState\<...\>)) |
+| `options` | `TOptions` |
+| ...`args` | `CreateRouteWithProps`\<`TOptions`, `TProps`\> |
 
-### Returns
+## Returns
 
-[`Route`](../types/Route.md)\<`ToName`\<`TName`\>, `Host`\<`""`, \{\}\>, `CombinePath`\<`TParent`\[`"path"`\], `ToPath`\<`TPath`\>\>, `CombineQuery`\<`TParent`\[`"query"`\], `ToQuery`\<`TQuery`\>\>, `CombineHash`\<`TParent`\[`"hash"`\], `ToHash`\<`THash`\>\>, `CombineMeta`\<`TMeta`, `TParent`\[`"meta"`\]\>, `CombineState`\<`TState`, `TParent`\[`"state"`\]\>, `TName` \| `TParent`\[`"matches"`\]\[`number`\]\[`"name"`\]\>
+`ToRoute`\<`TOptions`, `CreateRouteProps`\<`TOptions`\> *extends* `TProps` ? `undefined` : `TProps`\>
diff --git a/docs/api/functions/createRouter.md b/docs/api/functions/createRouter.md
@@ -53,7 +53,7 @@ const router = createRouter(routes)
 
 ```ts
 function createRouter<TRoutes, TOptions, TPlugin>(
-   arrayOfRoutes, 
+   routes, 
    options?, 
 plugins?): Router<TRoutes, TOptions, TPlugin>
 ```
@@ -72,7 +72,7 @@ Creates a router instance for a Vue application, equipped with methods for route
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `arrayOfRoutes` | `TRoutes`[] | - |
+| `routes` | `TRoutes`[] | [Routes](../types/Routes.md) An array of route definitions specifying the configuration of routes in the application. Use createRoute method to create the route definitions. |
 | `options`? | `TOptions` | [RouterOptions](../types/RouterOptions.md) for the router, including history mode and initial URL settings. |
 | `plugins`? | `TPlugin`[] | - |
 

diff --git a/docs/api/hooks/onAfterRouteEnter.md b/docs/api/hooks/onAfterRouteEnter.md