From 7e6c4e2d5bbb27f0fda38b4c6f1b0462e8d83416 Mon Sep 17 00:00:00 2001 From: pooya parsa Date: Wed, 30 Mar 2022 10:17:46 +0200 Subject: [PATCH] fix(schema): fix RouterConfig types (#3964) --- docs/content/3.docs/2.directory-structure/10.pages.md | 4 ++-- packages/schema/src/config/router.ts | 2 +- packages/schema/src/types/router.ts | 11 +++++++++-- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/content/3.docs/2.directory-structure/10.pages.md b/docs/content/3.docs/2.directory-structure/10.pages.md index e5395764a..7baa97380 100644 --- a/docs/content/3.docs/2.directory-structure/10.pages.md +++ b/docs/content/3.docs/2.directory-structure/10.pages.md @@ -274,10 +274,10 @@ It is possible to set default [vue-router options](https://router.vuejs.org/api/ This is the recommaned way to specify router options. ```js [app/router.options.ts] -import type { RouterOptions } from '@nuxt/schema' +import type { RouterConfig } from '@nuxt/schema' // https://router.vuejs.org/api/#routeroptions -export default { +export default { } ``` diff --git a/packages/schema/src/config/router.ts b/packages/schema/src/config/router.ts index e8dae2aa3..3b5176de9 100644 --- a/packages/schema/src/config/router.ts +++ b/packages/schema/src/config/router.ts @@ -9,7 +9,7 @@ export default { * For more control, you can use `app/router.optionts.ts` file. * * @see [documentation](https://router.vuejs.org/api/#routeroptions) - * @type {import('../src/types/router').RouterConfigOptions} + * @type {import('../src/types/router').RouterConfigSerializable} * * @version 3 */ diff --git a/packages/schema/src/types/router.ts b/packages/schema/src/types/router.ts index a5cb900c0..03e0fabdc 100644 --- a/packages/schema/src/types/router.ts +++ b/packages/schema/src/types/router.ts @@ -1,9 +1,16 @@ import type { RouterOptions as _RouterOptions } from 'vue-router' -export type RouterOptions = Exclude<_RouterOptions, 'history' | 'routes'> +export type RouterConfig = Partial> + +/** @deprecated Use RouterConfig instead */ +export type RouterOptions = RouterConfig /** * Only JSON serializable router options are configurable from nuxt config */ -export type RouterConfigOptions = Pick +export type RouterConfigSerializable = Pick + + +/** @deprecated Use RouterConfigSerializable instead */ +export type RouterConfigOptions = RouterConfigSerializable