Skip to content

Commit dac1e39

Browse files
committed
fix(types): fix Configuration interface
1 parent 20c8b9b commit dac1e39

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

packages/types/config/index.d.ts

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { NuxtOptionsModule } from './module'
1313
import { NuxtOptionsPlugin } from './plugin'
1414
import { NuxtOptionsRender } from './render'
1515
import { NuxtOptionsRouter } from './router'
16-
import { NuxtConfigurationRuntimeConfig } from './runtime'
16+
import { NuxtOptionsRuntimeConfig } from './runtime'
1717
import { NuxtOptionsServer } from './server'
1818
import { NuxtOptionsServerMiddleware } from './server-middleware'
1919
import { NuxtOptionsVueConfiguration } from './vue-configuration'
@@ -51,8 +51,8 @@ export interface NuxtOptions extends Record<string, any> {
5151
modules: NuxtOptionsModule[]
5252
modulesDir: string[]
5353
plugins: NuxtOptionsPlugin[]
54-
privateRuntimeConfig?: NuxtConfigurationRuntimeConfig
55-
publicRuntimeConfig?: NuxtConfigurationRuntimeConfig
54+
privateRuntimeConfig: NuxtOptionsRuntimeConfig
55+
publicRuntimeConfig: NuxtOptionsRuntimeConfig
5656
render: NuxtOptionsRender
5757
rootDir: string
5858
router: NuxtOptionsRouter
@@ -65,9 +65,7 @@ export interface NuxtOptions extends Record<string, any> {
6565
watchers: NuxtOptionsWatchers
6666
}
6767

68-
export type NuxtConfig = Partial<NuxtOptions>
69-
70-
/**
71-
* @deprecated Use NuxtConfig instead
72-
*/
73-
export type Configuration = NuxtConfig // Legacy alias
68+
// Modules can either extend `Configuration` or `NuxtConfig`
69+
// Users should use `NuxtConfig` over `Configuration` in their configuration file
70+
export interface Configuration extends Partial<NuxtOptions> {}
71+
export interface NuxtConfig extends Configuration {}

packages/types/config/runtime.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/**
2-
* NuxtConfigurationRuntimeConfig
2+
* NuxtOptionsRuntimeConfig
33
* NuxtRuntimeConfig interface can be extended by users to enable intellisense on $config
44
*/
55

66
export interface NuxtRuntimeConfig {
77
[key: string]: any
88
}
99

10-
export type NuxtConfigurationRuntimeConfig = NuxtRuntimeConfig | ((env: typeof process.env) => NuxtRuntimeConfig)
10+
export type NuxtOptionsRuntimeConfig = NuxtRuntimeConfig | ((env: typeof process.env) => NuxtRuntimeConfig)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy