@nuxt/bridge-schema-edge 0.0.0 → 3.0.0-27833237.ddd8ecc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.d.ts +1593 -0
- package/dist/index.mjs +545 -0
- package/package.json +43 -3
- package/schema/config.d.ts +1575 -0
- package/schema/config.defaults.json +345 -0
- package/schema/config.md +1556 -0
- package/schema/config.schema.json +2900 -0
|
@@ -0,0 +1,1575 @@
|
|
|
1
|
+
import type { VueConfiguration } from 'vue/types/vue'
|
|
2
|
+
import type { VueMetaOptions, MetaInfo } from 'vue-meta'
|
|
3
|
+
import type { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer'
|
|
4
|
+
import type { PluginVisualizerOptions } from 'rollup-plugin-visualizer'
|
|
5
|
+
export interface ConfigSchema {
|
|
6
|
+
vue: {
|
|
7
|
+
/**
|
|
8
|
+
* Properties that will be set directly on `Vue.config` for vue@2.
|
|
9
|
+
*
|
|
10
|
+
* @see [vue@2 Documentation](https://v2.vuejs.org/v2/api/#Global-Config)
|
|
11
|
+
*/
|
|
12
|
+
config: VueConfiguration,
|
|
13
|
+
},
|
|
14
|
+
|
|
15
|
+
app: {
|
|
16
|
+
/**
|
|
17
|
+
* The folder name for the built site assets, relative to `baseURL` (or `cdnURL` if set).
|
|
18
|
+
*
|
|
19
|
+
* @deprecated - use `buildAssetsDir` instead
|
|
20
|
+
*/
|
|
21
|
+
assetsPath: any,
|
|
22
|
+
},
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* The path to an HTML template file for rendering Nuxt responses. Uses `<srcDir>/app.html` if it exists, or the Nuxt's default template if not.
|
|
26
|
+
* @default "/home/runner/work/bridge/bridge/packages/bridge-schema/views/app.template.html"
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```html
|
|
30
|
+
* <!DOCTYPE html>
|
|
31
|
+
* <html {{ HTML_ATTRS }}>
|
|
32
|
+
* <head {{ HEAD_ATTRS }}>
|
|
33
|
+
* {{ HEAD }}
|
|
34
|
+
* </head>
|
|
35
|
+
* <body {{ BODY_ATTRS }}>
|
|
36
|
+
* {{ APP }}
|
|
37
|
+
* </body>
|
|
38
|
+
* </html>
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
appTemplatePath: string,
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Enable or disable Vuex store.
|
|
45
|
+
* By default, it is enabled if there is a `store/` directory.
|
|
46
|
+
* @default false
|
|
47
|
+
*/
|
|
48
|
+
store: boolean,
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Options to pass directly to `vue-meta`.
|
|
52
|
+
*
|
|
53
|
+
* @see [documentation](https://vue-meta.nuxtjs.org/api/#plugin-options).
|
|
54
|
+
*/
|
|
55
|
+
vueMeta: VueMetaOptions,
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Set default configuration for `<head>` on every page.
|
|
59
|
+
*
|
|
60
|
+
* @see [documentation](https://vue-meta.nuxtjs.org/api/#metainfo-properties) for specifics.
|
|
61
|
+
*/
|
|
62
|
+
head: MetaInfo,
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @deprecated - use `head` instead
|
|
67
|
+
*/
|
|
68
|
+
meta: {
|
|
69
|
+
meta: Array<any>,
|
|
70
|
+
|
|
71
|
+
link: Array<any>,
|
|
72
|
+
|
|
73
|
+
style: Array<any>,
|
|
74
|
+
|
|
75
|
+
script: Array<any>,
|
|
76
|
+
},
|
|
77
|
+
|
|
78
|
+
/** Configuration for the Nuxt `fetch()` hook. */
|
|
79
|
+
fetch: {
|
|
80
|
+
/**
|
|
81
|
+
* Whether to enable `fetch()` on the server.
|
|
82
|
+
* @default true
|
|
83
|
+
*/
|
|
84
|
+
server: boolean,
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Whether to enable `fetch()` on the client.
|
|
88
|
+
* @default true
|
|
89
|
+
*/
|
|
90
|
+
client: boolean,
|
|
91
|
+
},
|
|
92
|
+
|
|
93
|
+
/** You may want to extend plugins or change their order. For this, you can pass a function using `extendPlugins`. It accepts an array of plugin objects and should return an array of plugin objects. */
|
|
94
|
+
extendPlugins: (plugins: Array<{ src: string, mode?: 'client' | 'server' }>) => Array<{ src: string, mode?: 'client' | 'server' }>,
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* An object where each key name maps to a path to a layout .vue file.
|
|
98
|
+
* Normally, there is no need to configure this directly.
|
|
99
|
+
*/
|
|
100
|
+
layouts: Record<string, string>,
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Set a custom error page layout.
|
|
104
|
+
* Normally, there is no need to configure this directly.
|
|
105
|
+
* @default null
|
|
106
|
+
*/
|
|
107
|
+
ErrorPage: string,
|
|
108
|
+
|
|
109
|
+
/** Configure the Nuxt loading progress bar component that's shown between routes. Set to `false` to disable. You can also customize it or create your own component. */
|
|
110
|
+
loading: {
|
|
111
|
+
/**
|
|
112
|
+
* CSS color of the progress bar.
|
|
113
|
+
* @default "black"
|
|
114
|
+
*/
|
|
115
|
+
color: string,
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* CSS color of the progress bar when an error appended while rendering the route (if data or fetch sent back an error, for example).
|
|
119
|
+
* @default "red"
|
|
120
|
+
*/
|
|
121
|
+
failedColor: string,
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Height of the progress bar (used in the style property of the progress bar).
|
|
125
|
+
* @default "2px"
|
|
126
|
+
*/
|
|
127
|
+
height: string,
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* In ms, wait for the specified time before displaying the progress bar. Useful for preventing the bar from flashing.
|
|
131
|
+
* @default 200
|
|
132
|
+
*/
|
|
133
|
+
throttle: number,
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* In ms, the maximum duration of the progress bar, Nuxt assumes that the route will be rendered before 5 seconds.
|
|
137
|
+
* @default 5000
|
|
138
|
+
*/
|
|
139
|
+
duration: number,
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Keep animating progress bar when loading takes longer than duration.
|
|
143
|
+
* @default false
|
|
144
|
+
*/
|
|
145
|
+
continuous: boolean,
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Set the direction of the progress bar from right to left.
|
|
149
|
+
* @default false
|
|
150
|
+
*/
|
|
151
|
+
rtl: boolean,
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Set to `false` to remove default progress bar styles (and add your own).
|
|
155
|
+
* @default true
|
|
156
|
+
*/
|
|
157
|
+
css: boolean,
|
|
158
|
+
},
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Show a loading spinner while the page is loading (only when `ssr: false`).
|
|
162
|
+
* Set to `false` to disable. Alternatively, you can pass a string name or an object for more configuration. The name can refer to an indicator from [SpinKit](https://tobiasahlin.com/spinkit/) or a path to an HTML template of the indicator source code (in this case, all the other options will be passed to the template).
|
|
163
|
+
*/
|
|
164
|
+
loadingIndicator: {
|
|
165
|
+
[key: string]: any
|
|
166
|
+
},
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Used to set the default properties of the page transitions.
|
|
170
|
+
* You can either pass a string (the transition name) or an object with properties to bind to the `<Transition>` component that will wrap your pages.
|
|
171
|
+
*
|
|
172
|
+
* @see [vue@2 documentation](https://v2.vuejs.org/v2/guide/transitions.html)
|
|
173
|
+
*
|
|
174
|
+
* @see [vue@3 documentation](https://vuejs.org/guide/built-ins/transition-group.html#enter-leave-transitions)
|
|
175
|
+
*/
|
|
176
|
+
pageTransition: {
|
|
177
|
+
[key: string]: any
|
|
178
|
+
},
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* Used to set the default properties of the layout transitions.
|
|
182
|
+
* You can either pass a string (the transition name) or an object with properties to bind to the `<Transition>` component that will wrap your layouts.
|
|
183
|
+
*
|
|
184
|
+
* @see [vue@2 documentation](https://v2.vuejs.org/v2/guide/transitions.html)
|
|
185
|
+
*/
|
|
186
|
+
layoutTransition: {
|
|
187
|
+
[key: string]: any
|
|
188
|
+
},
|
|
189
|
+
|
|
190
|
+
/** You can disable specific Nuxt features that you do not want. */
|
|
191
|
+
features: {
|
|
192
|
+
/**
|
|
193
|
+
* Set to false to disable Nuxt vuex integration
|
|
194
|
+
* @default true
|
|
195
|
+
*/
|
|
196
|
+
store: boolean,
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Set to false to disable layouts
|
|
200
|
+
* @default true
|
|
201
|
+
*/
|
|
202
|
+
layouts: boolean,
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Set to false to disable Nuxt integration with `vue-meta` and the `head` property
|
|
206
|
+
* @default true
|
|
207
|
+
*/
|
|
208
|
+
meta: boolean,
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Set to false to disable middleware
|
|
212
|
+
* @default true
|
|
213
|
+
*/
|
|
214
|
+
middleware: boolean,
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* Set to false to disable transitions
|
|
218
|
+
* @default true
|
|
219
|
+
*/
|
|
220
|
+
transitions: boolean,
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Set to false to disable support for deprecated features and aliases
|
|
224
|
+
* @default true
|
|
225
|
+
*/
|
|
226
|
+
deprecations: boolean,
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Set to false to disable the Nuxt `validate()` hook
|
|
230
|
+
* @default true
|
|
231
|
+
*/
|
|
232
|
+
validate: boolean,
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Set to false to disable the Nuxt `asyncData()` hook
|
|
236
|
+
* @default true
|
|
237
|
+
*/
|
|
238
|
+
useAsyncData: boolean,
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Set to false to disable the Nuxt `fetch()` hook
|
|
242
|
+
* @default true
|
|
243
|
+
*/
|
|
244
|
+
fetch: boolean,
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Set to false to disable `$nuxt.isOnline`
|
|
248
|
+
* @default true
|
|
249
|
+
*/
|
|
250
|
+
clientOnline: boolean,
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Set to false to disable prefetching behavior in `<NuxtLink>`
|
|
254
|
+
* @default true
|
|
255
|
+
*/
|
|
256
|
+
clientPrefetch: boolean,
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Set to false to disable extra component aliases like `<NLink>` and `<NChild>`
|
|
260
|
+
* @default true
|
|
261
|
+
*/
|
|
262
|
+
componentAliases: boolean,
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Set to false to disable the `<ClientOnly>` component (see [docs](https://github.com/egoist/vue-client-only))
|
|
266
|
+
* @default true
|
|
267
|
+
*/
|
|
268
|
+
componentClientOnly: boolean,
|
|
269
|
+
},
|
|
270
|
+
|
|
271
|
+
build: {
|
|
272
|
+
/**
|
|
273
|
+
* Suppresses most of the build output log.
|
|
274
|
+
* It is enabled by default when a CI or test environment is detected.
|
|
275
|
+
* @default true
|
|
276
|
+
*
|
|
277
|
+
* @see [std-env](https://github.com/unjs/std-env)
|
|
278
|
+
*/
|
|
279
|
+
quiet: boolean,
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Nuxt uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
|
|
283
|
+
* Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
|
|
284
|
+
* @default false
|
|
285
|
+
*
|
|
286
|
+
* @example
|
|
287
|
+
* ```js
|
|
288
|
+
* analyze: {
|
|
289
|
+
* analyzerMode: 'static'
|
|
290
|
+
* }
|
|
291
|
+
* ```
|
|
292
|
+
*/
|
|
293
|
+
analyze: boolean | BundleAnalyzerPlugin.Options | PluginVisualizerOptions,
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Enable the profiler in webpackbar.
|
|
297
|
+
* It is normally enabled by CLI argument `--profile`.
|
|
298
|
+
* @default false
|
|
299
|
+
*
|
|
300
|
+
* @see [webpackbar](https://github.com/unjs/webpackbar#profile)
|
|
301
|
+
*/
|
|
302
|
+
profile: boolean,
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Enables Common CSS Extraction using [Vue Server Renderer guidelines](https://ssr.vuejs.org/guide/css.html).
|
|
306
|
+
* Using [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin/) under the hood, your CSS will be extracted into separate files, usually one per component. This allows caching your CSS and JavaScript separately and is worth trying if you have a lot of global or shared CSS.
|
|
307
|
+
* @default false
|
|
308
|
+
*
|
|
309
|
+
* @example
|
|
310
|
+
* ```js
|
|
311
|
+
* export default {
|
|
312
|
+
* build: {
|
|
313
|
+
* extractCSS: true,
|
|
314
|
+
* // or
|
|
315
|
+
* extractCSS: {
|
|
316
|
+
* ignoreOrder: true
|
|
317
|
+
* }
|
|
318
|
+
* }
|
|
319
|
+
* }
|
|
320
|
+
* ```
|
|
321
|
+
*
|
|
322
|
+
* If you want to extract all your CSS to a single file, there is a workaround for this.
|
|
323
|
+
* However, note that it is not recommended to extract everything into a single file.
|
|
324
|
+
* Extracting into multiple CSS files is better for caching and preload isolation. It
|
|
325
|
+
* can also improve page performance by downloading and resolving only those resources
|
|
326
|
+
* that are needed.
|
|
327
|
+
*
|
|
328
|
+
* @example
|
|
329
|
+
* ```js
|
|
330
|
+
* export default {
|
|
331
|
+
* build: {
|
|
332
|
+
* extractCSS: true,
|
|
333
|
+
* optimization: {
|
|
334
|
+
* splitChunks: {
|
|
335
|
+
* cacheGroups: {
|
|
336
|
+
* styles: {
|
|
337
|
+
* name: 'styles',
|
|
338
|
+
* test: /\.(css|vue)$/,
|
|
339
|
+
* chunks: 'all',
|
|
340
|
+
* enforce: true
|
|
341
|
+
* }
|
|
342
|
+
* }
|
|
343
|
+
* }
|
|
344
|
+
* }
|
|
345
|
+
* }
|
|
346
|
+
* }
|
|
347
|
+
* ```
|
|
348
|
+
*/
|
|
349
|
+
extractCSS: boolean,
|
|
350
|
+
|
|
351
|
+
/** Enables CSS source map support (defaults to true in development) */
|
|
352
|
+
cssSourceMap: any,
|
|
353
|
+
|
|
354
|
+
/** Creates special webpack bundle for SSR renderer. It is normally not necessary to change this value. */
|
|
355
|
+
ssr: any,
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* Enable [thread-loader](https://github.com/webpack-contrib/thread-loader#thread-loader) when building app with webpack.
|
|
359
|
+
* @default false
|
|
360
|
+
*
|
|
361
|
+
* @warning This is an unstable feature.
|
|
362
|
+
*/
|
|
363
|
+
parallel: boolean,
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Enable caching for [`terser-webpack-plugin`](https://github.com/webpack-contrib/terser-webpack-plugin#options) and [`cache-loader`](https://github.com/webpack-contrib/cache-loader#cache-loader).
|
|
367
|
+
* @default false
|
|
368
|
+
*
|
|
369
|
+
* @warning This is an unstable feature.
|
|
370
|
+
*/
|
|
371
|
+
cache: boolean,
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* Inline server bundle dependencies.
|
|
375
|
+
* This mode bundles `node_modules` that are normally preserved as externals in the server build.
|
|
376
|
+
* @default false
|
|
377
|
+
*
|
|
378
|
+
* @warning Runtime dependencies (modules, `nuxt.config`, server middleware and the static directory) are not bundled.
|
|
379
|
+
* This feature only disables use of [webpack-externals](https://webpack.js.org/configuration/externals/) for server-bundle.
|
|
380
|
+
*
|
|
381
|
+
* @note You can enable standalone bundling by passing `--standalone` via the command line.
|
|
382
|
+
*
|
|
383
|
+
* @see [context](https://github.com/nuxt/nuxt.js/pull/4661)
|
|
384
|
+
*/
|
|
385
|
+
standalone: boolean,
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* If you are uploading your dist files to a CDN, you can set the publicPath to your CDN.
|
|
389
|
+
*
|
|
390
|
+
* @note This is only applied in production.
|
|
391
|
+
*
|
|
392
|
+
* The value of this property at runtime will override the configuration of an app that
|
|
393
|
+
* has already been built.
|
|
394
|
+
*
|
|
395
|
+
* @example
|
|
396
|
+
* ```js
|
|
397
|
+
* build: {
|
|
398
|
+
* publicPath: process.env.PUBLIC_PATH || 'https://cdn.nuxtjs.org'
|
|
399
|
+
* }
|
|
400
|
+
* ```
|
|
401
|
+
*/
|
|
402
|
+
publicPath: any,
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* The polyfill library to load to provide URL and URLSearchParams.
|
|
406
|
+
* Defaults to `'url'` ([see package](https://www.npmjs.com/package/url)).
|
|
407
|
+
* @default "url"
|
|
408
|
+
*/
|
|
409
|
+
serverURLPolyfill: string,
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Customize bundle filenames.
|
|
413
|
+
* To understand a bit more about the use of manifests, take a look at [this webpack documentation](https://webpack.js.org/guides/code-splitting/).
|
|
414
|
+
*
|
|
415
|
+
* @note Be careful when using non-hashed based filenames in production
|
|
416
|
+
* as most browsers will cache the asset and not detect the changes on first load.
|
|
417
|
+
*
|
|
418
|
+
* This example changes fancy chunk names to numerical ids:
|
|
419
|
+
*
|
|
420
|
+
* @example
|
|
421
|
+
* ```js
|
|
422
|
+
* filenames: {
|
|
423
|
+
* chunk: ({ isDev }) => (isDev ? '[name].js' : '[id].[contenthash].js')
|
|
424
|
+
* }
|
|
425
|
+
* ```
|
|
426
|
+
*/
|
|
427
|
+
filenames: Record<string, ((arg: any) => string)>,
|
|
428
|
+
|
|
429
|
+
/** Customize the options of Nuxt's integrated webpack loaders. */
|
|
430
|
+
loaders: {
|
|
431
|
+
file: {
|
|
432
|
+
/** @default false */
|
|
433
|
+
esModule: boolean,
|
|
434
|
+
},
|
|
435
|
+
|
|
436
|
+
fontUrl: {
|
|
437
|
+
/** @default false */
|
|
438
|
+
esModule: boolean,
|
|
439
|
+
|
|
440
|
+
/** @default 1000 */
|
|
441
|
+
limit: number,
|
|
442
|
+
},
|
|
443
|
+
|
|
444
|
+
imgUrl: {
|
|
445
|
+
/** @default false */
|
|
446
|
+
esModule: boolean,
|
|
447
|
+
|
|
448
|
+
/** @default 1000 */
|
|
449
|
+
limit: number,
|
|
450
|
+
},
|
|
451
|
+
|
|
452
|
+
pugPlain: any,
|
|
453
|
+
|
|
454
|
+
vue: {
|
|
455
|
+
/** @default true */
|
|
456
|
+
productionMode: boolean,
|
|
457
|
+
|
|
458
|
+
transformAssetUrls: {
|
|
459
|
+
/** @default "src" */
|
|
460
|
+
video: string,
|
|
461
|
+
|
|
462
|
+
/** @default "src" */
|
|
463
|
+
source: string,
|
|
464
|
+
|
|
465
|
+
/** @default "src" */
|
|
466
|
+
object: string,
|
|
467
|
+
|
|
468
|
+
/** @default "src" */
|
|
469
|
+
embed: string,
|
|
470
|
+
},
|
|
471
|
+
|
|
472
|
+
compilerOptions: any,
|
|
473
|
+
},
|
|
474
|
+
|
|
475
|
+
css: {
|
|
476
|
+
/** @default 0 */
|
|
477
|
+
importLoaders: number,
|
|
478
|
+
|
|
479
|
+
/** @default false */
|
|
480
|
+
esModule: boolean,
|
|
481
|
+
},
|
|
482
|
+
|
|
483
|
+
cssModules: {
|
|
484
|
+
/** @default 0 */
|
|
485
|
+
importLoaders: number,
|
|
486
|
+
|
|
487
|
+
/** @default false */
|
|
488
|
+
esModule: boolean,
|
|
489
|
+
|
|
490
|
+
modules: {
|
|
491
|
+
/** @default "[local]_[hash:base64:5]" */
|
|
492
|
+
localIdentName: string,
|
|
493
|
+
},
|
|
494
|
+
},
|
|
495
|
+
|
|
496
|
+
less: any,
|
|
497
|
+
|
|
498
|
+
sass: {
|
|
499
|
+
sassOptions: {
|
|
500
|
+
/** @default true */
|
|
501
|
+
indentedSyntax: boolean,
|
|
502
|
+
},
|
|
503
|
+
},
|
|
504
|
+
|
|
505
|
+
scss: any,
|
|
506
|
+
|
|
507
|
+
stylus: any,
|
|
508
|
+
|
|
509
|
+
vueStyle: any,
|
|
510
|
+
},
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
*
|
|
514
|
+
* @deprecated Use [style-resources-module](https://github.com/nuxt-community/style-resources-module/)
|
|
515
|
+
*/
|
|
516
|
+
styleResources: any,
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* Add webpack plugins.
|
|
520
|
+
*
|
|
521
|
+
* @example
|
|
522
|
+
* ```js
|
|
523
|
+
* import webpack from 'webpack'
|
|
524
|
+
* import { version } from './package.json'
|
|
525
|
+
* // ...
|
|
526
|
+
* plugins: [
|
|
527
|
+
* new webpack.DefinePlugin({
|
|
528
|
+
* 'process.VERSION': version
|
|
529
|
+
* })
|
|
530
|
+
* ]
|
|
531
|
+
* ```
|
|
532
|
+
*/
|
|
533
|
+
plugins: Array<any>,
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* Terser plugin options.
|
|
537
|
+
* Set to false to disable this plugin, or pass an object of options.
|
|
538
|
+
*
|
|
539
|
+
* @see [terser-webpack-plugin documentation](https://github.com/webpack-contrib/terser-webpack-plugin)
|
|
540
|
+
*
|
|
541
|
+
* @note Enabling sourcemap will leave `//# sourcemappingURL` linking comment at
|
|
542
|
+
* the end of each output file if webpack `config.devtool` is set to `source-map`.
|
|
543
|
+
*/
|
|
544
|
+
terser: any,
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* Enables the [HardSourceWebpackPlugin](https://github.com/mzgoddard/hard-source-webpack-plugin) for improved caching.
|
|
548
|
+
* @default false
|
|
549
|
+
*
|
|
550
|
+
* @warning unstable
|
|
551
|
+
*/
|
|
552
|
+
hardSource: boolean,
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-shake bundle.
|
|
556
|
+
* @default false
|
|
557
|
+
*/
|
|
558
|
+
aggressiveCodeRemoval: boolean,
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* OptimizeCSSAssets plugin options.
|
|
562
|
+
* Defaults to true when `extractCSS` is enabled.
|
|
563
|
+
* @default false
|
|
564
|
+
*
|
|
565
|
+
* @see [optimize-css-assets-webpack-plugin documentation](https://github.com/NMFR/optimize-css-assets-webpack-plugin).
|
|
566
|
+
*/
|
|
567
|
+
optimizeCSS: boolean,
|
|
568
|
+
|
|
569
|
+
/** Configure [webpack optimization](https://webpack.js.org/configuration/optimization/). */
|
|
570
|
+
optimization: {
|
|
571
|
+
/** @default "single" */
|
|
572
|
+
runtimeChunk: string,
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* Set minimize to false to disable all minimizers. (It is disabled in development by default)
|
|
576
|
+
* @default true
|
|
577
|
+
*/
|
|
578
|
+
minimize: boolean,
|
|
579
|
+
|
|
580
|
+
/** You can set minimizer to a customized array of plugins. */
|
|
581
|
+
minimizer: any,
|
|
582
|
+
|
|
583
|
+
splitChunks: {
|
|
584
|
+
/** @default "all" */
|
|
585
|
+
chunks: string,
|
|
586
|
+
|
|
587
|
+
/** @default "/" */
|
|
588
|
+
automaticNameDelimiter: string,
|
|
589
|
+
|
|
590
|
+
cacheGroups: any,
|
|
591
|
+
},
|
|
592
|
+
},
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Whether to split code for `layout`, `pages` and `commons` chunks.
|
|
596
|
+
* Commons libs include `vue`, `vue-loader`, `vue-router`, `vuex`, etc.
|
|
597
|
+
*/
|
|
598
|
+
splitChunks: {
|
|
599
|
+
/** @default false */
|
|
600
|
+
layouts: boolean,
|
|
601
|
+
|
|
602
|
+
/** @default true */
|
|
603
|
+
pages: boolean,
|
|
604
|
+
|
|
605
|
+
/** @default true */
|
|
606
|
+
commons: boolean,
|
|
607
|
+
},
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Nuxt will automatically detect the current version of `core-js` in your project (`'auto'`), or you can specify which version you want to use (`2` or `3`).
|
|
611
|
+
* @default "auto"
|
|
612
|
+
*/
|
|
613
|
+
corejs: string,
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
* Customize your Babel configuration.
|
|
617
|
+
* See [babel-loader options](https://github.com/babel/babel-loader#options) and [babel options](https://babeljs.io/docs/en/options).
|
|
618
|
+
*
|
|
619
|
+
* @note `.babelrc` is ignored by default.
|
|
620
|
+
*/
|
|
621
|
+
babel: {
|
|
622
|
+
/** @default false */
|
|
623
|
+
configFile: boolean,
|
|
624
|
+
|
|
625
|
+
/** @default false */
|
|
626
|
+
babelrc: boolean,
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* An array of Babel plugins to load, or a function that takes webpack context and returns an array of Babel plugins.
|
|
630
|
+
* For more information see [Babel plugins options](https://babeljs.io/docs/en/options#plugins) and [babel-loader options](https://github.com/babel/babel-loader#options).
|
|
631
|
+
*/
|
|
632
|
+
plugins: Array<any>,
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* The Babel presets to be applied.
|
|
636
|
+
*
|
|
637
|
+
* @note The presets configured here will be applied to both the client and the server
|
|
638
|
+
* build. The target will be set by Nuxt accordingly (client/server). If you want to configure
|
|
639
|
+
* the preset differently for the client or the server build, please use presets as a function.
|
|
640
|
+
*
|
|
641
|
+
* @warning It is highly recommended to use the default preset instead customizing.
|
|
642
|
+
*
|
|
643
|
+
* @example
|
|
644
|
+
* ```js
|
|
645
|
+
* export default {
|
|
646
|
+
* build: {
|
|
647
|
+
* babel: {
|
|
648
|
+
* presets({ isServer }, [ preset, options ]) {
|
|
649
|
+
* // change options directly
|
|
650
|
+
* options.targets = isServer ? '...' : '...'
|
|
651
|
+
* options.corejs = '...'
|
|
652
|
+
* // return nothing
|
|
653
|
+
* }
|
|
654
|
+
* }
|
|
655
|
+
* }
|
|
656
|
+
* }
|
|
657
|
+
* ```
|
|
658
|
+
*
|
|
659
|
+
* @example
|
|
660
|
+
* ```js
|
|
661
|
+
* export default {
|
|
662
|
+
* build: {
|
|
663
|
+
* babel: {
|
|
664
|
+
* presets({ isServer }, [preset, options]) {
|
|
665
|
+
* return [
|
|
666
|
+
* [
|
|
667
|
+
* preset,
|
|
668
|
+
* {
|
|
669
|
+
* targets: isServer ? '...' : '...',
|
|
670
|
+
* ...options
|
|
671
|
+
* }
|
|
672
|
+
* ],
|
|
673
|
+
* [
|
|
674
|
+
* // Other presets
|
|
675
|
+
* ]
|
|
676
|
+
* ]
|
|
677
|
+
* }
|
|
678
|
+
* }
|
|
679
|
+
* }
|
|
680
|
+
* }
|
|
681
|
+
* ```
|
|
682
|
+
*/
|
|
683
|
+
presets: any,
|
|
684
|
+
|
|
685
|
+
cacheDirectory: any,
|
|
686
|
+
},
|
|
687
|
+
|
|
688
|
+
/** Customize PostCSS Loader plugins. Sames options as https://github.com/webpack-contrib/postcss-loader#options */
|
|
689
|
+
postcss: {
|
|
690
|
+
execute: any,
|
|
691
|
+
|
|
692
|
+
postcssOptions: {
|
|
693
|
+
[key: string]: any
|
|
694
|
+
},
|
|
695
|
+
|
|
696
|
+
sourcemap: any,
|
|
697
|
+
|
|
698
|
+
implementation: any,
|
|
699
|
+
|
|
700
|
+
/** @default "" */
|
|
701
|
+
order: string,
|
|
702
|
+
},
|
|
703
|
+
|
|
704
|
+
html: {
|
|
705
|
+
/**
|
|
706
|
+
* Configuration for the html-minifier plugin used to minify HTML files created during the build process (will be applied for all modes).
|
|
707
|
+
*
|
|
708
|
+
* @warning If you make changes, they won't be merged with the defaults!
|
|
709
|
+
*
|
|
710
|
+
* @example
|
|
711
|
+
* ```js
|
|
712
|
+
* export default {
|
|
713
|
+
* html: {
|
|
714
|
+
* minify: {
|
|
715
|
+
* collapseBooleanAttributes: true,
|
|
716
|
+
* decodeEntities: true,
|
|
717
|
+
* minifyCSS: true,
|
|
718
|
+
* minifyJS: true,
|
|
719
|
+
* processConditionalComments: true,
|
|
720
|
+
* removeEmptyAttributes: true,
|
|
721
|
+
* removeRedundantAttributes: true,
|
|
722
|
+
* trimCustomFragments: true,
|
|
723
|
+
* useShortDoctype: true
|
|
724
|
+
* }
|
|
725
|
+
* }
|
|
726
|
+
* }
|
|
727
|
+
* ```
|
|
728
|
+
*/
|
|
729
|
+
minify: {
|
|
730
|
+
/** @default true */
|
|
731
|
+
collapseBooleanAttributes: boolean,
|
|
732
|
+
|
|
733
|
+
/** @default true */
|
|
734
|
+
decodeEntities: boolean,
|
|
735
|
+
|
|
736
|
+
/** @default true */
|
|
737
|
+
minifyCSS: boolean,
|
|
738
|
+
|
|
739
|
+
/** @default true */
|
|
740
|
+
minifyJS: boolean,
|
|
741
|
+
|
|
742
|
+
/** @default true */
|
|
743
|
+
processConditionalComments: boolean,
|
|
744
|
+
|
|
745
|
+
/** @default true */
|
|
746
|
+
removeEmptyAttributes: boolean,
|
|
747
|
+
|
|
748
|
+
/** @default true */
|
|
749
|
+
removeRedundantAttributes: boolean,
|
|
750
|
+
|
|
751
|
+
/** @default true */
|
|
752
|
+
trimCustomFragments: boolean,
|
|
753
|
+
|
|
754
|
+
/** @default true */
|
|
755
|
+
useShortDoctype: boolean,
|
|
756
|
+
},
|
|
757
|
+
},
|
|
758
|
+
|
|
759
|
+
/** Allows setting a different app template (other than `@nuxt/vue-app`) */
|
|
760
|
+
template: any,
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* You can provide your custom files to watch and regenerate after changes.
|
|
764
|
+
* This feature is especially useful for using with modules.
|
|
765
|
+
*
|
|
766
|
+
* @example
|
|
767
|
+
* ```js
|
|
768
|
+
* watch: ['~/.nuxt/support.js']
|
|
769
|
+
* ```
|
|
770
|
+
*/
|
|
771
|
+
watch: Array<any>,
|
|
772
|
+
|
|
773
|
+
/** See [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) for available options. */
|
|
774
|
+
devMiddleware: {
|
|
775
|
+
/** @default "none" */
|
|
776
|
+
stats: string,
|
|
777
|
+
},
|
|
778
|
+
|
|
779
|
+
/** See [webpack-hot-middleware](https://github.com/webpack-contrib/webpack-hot-middleware) for available options. */
|
|
780
|
+
hotMiddleware: any,
|
|
781
|
+
|
|
782
|
+
vendor: {
|
|
783
|
+
"$meta": {
|
|
784
|
+
/** @default "vendor has been deprecated since nuxt 2" */
|
|
785
|
+
deprecated: string,
|
|
786
|
+
},
|
|
787
|
+
},
|
|
788
|
+
|
|
789
|
+
/**
|
|
790
|
+
* Set to `'none'` or `false` to disable stats printing out after a build.
|
|
791
|
+
* @default false
|
|
792
|
+
*/
|
|
793
|
+
stats: boolean,
|
|
794
|
+
|
|
795
|
+
/**
|
|
796
|
+
* Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](https://github.com/nuxt/friendly-errors-webpack-plugin).
|
|
797
|
+
* @default true
|
|
798
|
+
*/
|
|
799
|
+
friendlyErrors: boolean,
|
|
800
|
+
|
|
801
|
+
/** Additional extensions (beyond `['vue', 'js']` to support in `pages/`, `layouts/`, `middleware/`, etc.) */
|
|
802
|
+
additionalExtensions: Array<any>,
|
|
803
|
+
|
|
804
|
+
/** Filters to hide build warnings. */
|
|
805
|
+
warningIgnoreFilters: Array<any>,
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* Set to true to scan files within symlinks in the build (such as within `pages/`).
|
|
809
|
+
* @default false
|
|
810
|
+
*/
|
|
811
|
+
followSymlinks: boolean,
|
|
812
|
+
},
|
|
813
|
+
|
|
814
|
+
cli: {
|
|
815
|
+
/** Add a message to the CLI banner by adding a string to this array. */
|
|
816
|
+
badgeMessages: string[],
|
|
817
|
+
|
|
818
|
+
/**
|
|
819
|
+
* Change the color of the 'Nuxt.js' title in the CLI banner.
|
|
820
|
+
* @default "green"
|
|
821
|
+
*/
|
|
822
|
+
bannerColor: string,
|
|
823
|
+
},
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
* Your preferred code editor to launch when debugging.
|
|
827
|
+
*
|
|
828
|
+
* @see [documentation](https://github.com/yyx990803/launch-editor#supported-editors)
|
|
829
|
+
*/
|
|
830
|
+
editor: string,
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* The watch property lets you watch custom files for restarting the server.
|
|
834
|
+
* `chokidar` is used to set up the watchers. To learn more about its pattern options, see chokidar documentation.
|
|
835
|
+
*
|
|
836
|
+
* @see [chokidar](https://github.com/paulmillr/chokidar#api)
|
|
837
|
+
*
|
|
838
|
+
* @example
|
|
839
|
+
* ```js
|
|
840
|
+
* watch: ['~/custom/*.js']
|
|
841
|
+
* ```
|
|
842
|
+
*/
|
|
843
|
+
watch: string[],
|
|
844
|
+
|
|
845
|
+
/**
|
|
846
|
+
* The style extensions that should be resolved by the Nuxt resolver (for example, in `css` property).
|
|
847
|
+
* @default [".css",".pcss",".postcss",".styl",".stylus",".scss",".sass",".less"]
|
|
848
|
+
*/
|
|
849
|
+
styleExtensions: Array<string>,
|
|
850
|
+
|
|
851
|
+
dir: {
|
|
852
|
+
/**
|
|
853
|
+
* The assets directory (aliased as `~assets` in your build).
|
|
854
|
+
* @default "assets"
|
|
855
|
+
*/
|
|
856
|
+
assets: string,
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* The directory containing app template files like `app.html` and `router.scrollBehavior.js`
|
|
860
|
+
* @default "app"
|
|
861
|
+
*/
|
|
862
|
+
app: string,
|
|
863
|
+
|
|
864
|
+
/**
|
|
865
|
+
* Allows customizing the global ID used in the main HTML template as well as the main Vue instance name and other options.
|
|
866
|
+
* @default "nuxt"
|
|
867
|
+
*/
|
|
868
|
+
globalName: string,
|
|
869
|
+
|
|
870
|
+
/**
|
|
871
|
+
* Whether to produce a separate modern build targeting browsers that support ES modules.
|
|
872
|
+
* Set to `'server'` to enable server mode, where the Nuxt server checks browser version based on the user agent and serves the correct bundle.
|
|
873
|
+
* Set to `'client'` to serve both the modern bundle with `<script type="module">` and the legacy bundle with `<script nomodule>`. It will also provide a `<link rel="modulepreload">` for the modern bundle. Every browser that understands the module type will load the modern bundle while older browsers fall back to the legacy (transpiled) bundle.
|
|
874
|
+
* If you have set `modern: true` and are generating your app or have `ssr: false`, modern will be set to `'client'`.
|
|
875
|
+
* If you have set `modern: true` and are serving your app, modern will be set to `'server'`.
|
|
876
|
+
*
|
|
877
|
+
* @see [concept of modern mode](https://philipwalton.com/articles/deploying-es2015-code-in-production-today/)
|
|
878
|
+
*/
|
|
879
|
+
modern: 'server' | 'client' | boolean,
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* @default "universal"
|
|
883
|
+
*
|
|
884
|
+
* @deprecated `mode` option is deprecated
|
|
885
|
+
*
|
|
886
|
+
* @deprecated use `ssr` option
|
|
887
|
+
*/
|
|
888
|
+
mode: string,
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* The `env` property defines environment variables that should be available throughout your app (server- and client-side). They can be assigned using server-side environment variables.
|
|
892
|
+
*
|
|
893
|
+
* @note Nuxt uses webpack's `definePlugin` to define these environment variables.
|
|
894
|
+
* This means that the actual `process` or `process.env` from Node.js is neither
|
|
895
|
+
* available nor defined. Each of the `env` properties defined here is individually
|
|
896
|
+
* mapped to `process.env.xxxx` and converted during compilation.
|
|
897
|
+
*
|
|
898
|
+
* @note Environment variables starting with `NUXT_ENV_` are automatically injected
|
|
899
|
+
* into the process environment.
|
|
900
|
+
*/
|
|
901
|
+
env: {
|
|
902
|
+
[key: string]: any
|
|
903
|
+
},
|
|
904
|
+
|
|
905
|
+
/**
|
|
906
|
+
* Set the method Nuxt uses to require modules, such as loading `nuxt.config`, server middleware, and so on - defaulting to `jiti` (which has support for TypeScript and ESM syntax).
|
|
907
|
+
*
|
|
908
|
+
* @see [jiti](https://github.com/unjs/jiti)
|
|
909
|
+
*/
|
|
910
|
+
createRequire: 'jiti' | 'native' | ((p: string | { filename: string }) => NodeRequire),
|
|
911
|
+
|
|
912
|
+
/**
|
|
913
|
+
* Whether your Nuxt app should be built to be served by the Nuxt server (`server`) or as static HTML files suitable for a CDN or other static file server (`static`).
|
|
914
|
+
* This is unrelated to `ssr`.
|
|
915
|
+
* @default "server"
|
|
916
|
+
*/
|
|
917
|
+
target: 'server' | 'static',
|
|
918
|
+
|
|
919
|
+
/** Customizes specific global names (they are based on `globalName` by default). */
|
|
920
|
+
globals: {
|
|
921
|
+
id: (globalName: string) => string,
|
|
922
|
+
|
|
923
|
+
nuxt: (globalName: string) => string,
|
|
924
|
+
|
|
925
|
+
context: (globalName: string) => string,
|
|
926
|
+
|
|
927
|
+
pluginPrefix: (globalName: string) => string,
|
|
928
|
+
|
|
929
|
+
readyCallback: (globalName: string) => string,
|
|
930
|
+
|
|
931
|
+
loadedCallback: (globalName: string) => string,
|
|
932
|
+
},
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* The folder which will be used to auto-generate your Vuex store structure.
|
|
936
|
+
* @default "store"
|
|
937
|
+
*/
|
|
938
|
+
store: string,
|
|
939
|
+
},
|
|
940
|
+
|
|
941
|
+
/**
|
|
942
|
+
* Server middleware are connect/express/h3-shaped functions that handle server-side requests. They run on the server and before the Vue renderer.
|
|
943
|
+
* By adding entries to `serverMiddleware` you can register additional routes without the need for an external server.
|
|
944
|
+
* You can pass a string, which can be the name of a node dependency or a path to a file. You can also pass an object with `path` and `handler` keys (`handler` can be a path or a function).
|
|
945
|
+
*
|
|
946
|
+
* @note If you pass a function directly, it will only run in development mode.
|
|
947
|
+
*
|
|
948
|
+
* @example
|
|
949
|
+
* ```js
|
|
950
|
+
* serverMiddleware: [
|
|
951
|
+
* // Will register redirect-ssl npm package
|
|
952
|
+
* 'redirect-ssl',
|
|
953
|
+
* // Will register file from project server-middleware directory to handle /server-middleware/* requires
|
|
954
|
+
* { path: '/server-middleware', handler: '~/server-middleware/index.js' },
|
|
955
|
+
* // We can create custom instances too, but only in development mode, they are ignored for the production bundle.
|
|
956
|
+
* { path: '/static2', handler: serveStatic(fileURLToPath(new URL('./static2', import.meta.url))) }
|
|
957
|
+
* ]
|
|
958
|
+
* ```
|
|
959
|
+
*
|
|
960
|
+
* @note If you don't want middleware to run on all routes you should use the object
|
|
961
|
+
* form with a specific path.
|
|
962
|
+
*
|
|
963
|
+
* If you pass a string handler, Nuxt will expect that file to export a default function
|
|
964
|
+
* that handles `(req, res, next) => void`.
|
|
965
|
+
*
|
|
966
|
+
* @example
|
|
967
|
+
* ```js
|
|
968
|
+
* export default function (req, res, next) {
|
|
969
|
+
* // req is the Node.js http request object
|
|
970
|
+
* console.log(req.url)
|
|
971
|
+
* // res is the Node.js http response object
|
|
972
|
+
* // next is a function to call to invoke the next middleware
|
|
973
|
+
* // Don't forget to call next at the end if your middleware is not an endpoint!
|
|
974
|
+
* next()
|
|
975
|
+
* }
|
|
976
|
+
* ```
|
|
977
|
+
*
|
|
978
|
+
* Alternatively, it can export a connect/express/h3-type app instance.
|
|
979
|
+
*
|
|
980
|
+
* @example
|
|
981
|
+
* ```js
|
|
982
|
+
* import bodyParser from 'body-parser'
|
|
983
|
+
* import createApp from 'express'
|
|
984
|
+
* const app = createApp()
|
|
985
|
+
* app.use(bodyParser.json())
|
|
986
|
+
* app.all('/getJSON', (req, res) => {
|
|
987
|
+
* res.json({ data: 'data' })
|
|
988
|
+
* })
|
|
989
|
+
* export default app
|
|
990
|
+
* ```
|
|
991
|
+
*
|
|
992
|
+
* Alternatively, instead of passing an array of `serverMiddleware`, you can pass an object
|
|
993
|
+
* whose keys are the paths and whose values are the handlers (string or function).
|
|
994
|
+
*
|
|
995
|
+
* @example
|
|
996
|
+
* ```js
|
|
997
|
+
* export default {
|
|
998
|
+
* serverMiddleware: {
|
|
999
|
+
* '/a': '~/server-middleware/a.js',
|
|
1000
|
+
* '/b': '~/server-middleware/b.js',
|
|
1001
|
+
* '/c': '~/server-middleware/c.js'
|
|
1002
|
+
* }
|
|
1003
|
+
* }
|
|
1004
|
+
* ```
|
|
1005
|
+
*/
|
|
1006
|
+
serverMiddleware: Array<any>,
|
|
1007
|
+
|
|
1008
|
+
generate: {
|
|
1009
|
+
/**
|
|
1010
|
+
* Directory name that holds all the assets and generated pages for a `static` build.
|
|
1011
|
+
* @default "/home/runner/work/bridge/bridge/packages/bridge-schema/dist"
|
|
1012
|
+
*/
|
|
1013
|
+
dir: string,
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* The number of routes that are generated concurrently in the same thread.
|
|
1017
|
+
* @default 500
|
|
1018
|
+
*/
|
|
1019
|
+
concurrency: number,
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* Interval in milliseconds between two render cycles to avoid flooding a potential API with calls.
|
|
1023
|
+
* @default 0
|
|
1024
|
+
*/
|
|
1025
|
+
interval: number,
|
|
1026
|
+
|
|
1027
|
+
/**
|
|
1028
|
+
* Set to `false` to disable creating a directory + `index.html` for each route.
|
|
1029
|
+
* @default true
|
|
1030
|
+
*
|
|
1031
|
+
* @example
|
|
1032
|
+
* ```bash
|
|
1033
|
+
* # subFolders: true
|
|
1034
|
+
* -| dist/
|
|
1035
|
+
* ---| index.html
|
|
1036
|
+
* ---| about/
|
|
1037
|
+
* -----| index.html
|
|
1038
|
+
* ---| products/
|
|
1039
|
+
* -----| item/
|
|
1040
|
+
* -------| index.html
|
|
1041
|
+
*
|
|
1042
|
+
* # subFolders: false
|
|
1043
|
+
* -| dist/
|
|
1044
|
+
* ---| index.html
|
|
1045
|
+
* ---| about.html
|
|
1046
|
+
* ---| products/
|
|
1047
|
+
* -----| item.html
|
|
1048
|
+
* ```
|
|
1049
|
+
*/
|
|
1050
|
+
subFolders: boolean,
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* The path to the fallback HTML file.
|
|
1054
|
+
* Set this as the error page in your static server configuration, so that unknown routes can be rendered (on the client-side) by Nuxt.
|
|
1055
|
+
* If unset or set to a falsy value, the name of the fallback HTML file will be `200.html`. If set to `true`, the filename will be `404.html`. If you provide a string as a value, it will be used instead.
|
|
1056
|
+
* @default "200.html"
|
|
1057
|
+
*
|
|
1058
|
+
* @note Multiple services (e.g. Netlify) detect a `404.html` automatically. If
|
|
1059
|
+
* you configure your web server on your own, please consult its documentation
|
|
1060
|
+
* to find out how to set up an error page (and set it to the `404.html` file).
|
|
1061
|
+
*/
|
|
1062
|
+
fallback: string,
|
|
1063
|
+
|
|
1064
|
+
/**
|
|
1065
|
+
* Set to `false` to disable generating pages discovered through crawling relative links in generated pages.
|
|
1066
|
+
* @default true
|
|
1067
|
+
*/
|
|
1068
|
+
crawler: boolean,
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* Set to `false` to disable generating a `manifest.js` with a list of all generated pages.
|
|
1072
|
+
* @default true
|
|
1073
|
+
*/
|
|
1074
|
+
manifest: boolean,
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* Set to `false` to disable generating a `.nojekyll` file (which aids compatibility with GitHub Pages).
|
|
1078
|
+
* @default true
|
|
1079
|
+
*/
|
|
1080
|
+
nojekyll: boolean,
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* Configure the cache (used with `static` target to avoid rebuilding when no files have changed).
|
|
1084
|
+
* Set to `false` to disable completely.
|
|
1085
|
+
*/
|
|
1086
|
+
cache: {
|
|
1087
|
+
/** An array of files or directories to ignore. (It can also be a function that returns an array.) */
|
|
1088
|
+
ignore: Array<any>,
|
|
1089
|
+
|
|
1090
|
+
/** Options to pass to [`globby`](https://github.com/sindresorhus/globby), which is used to generate a 'snapshot' of the source files. */
|
|
1091
|
+
globbyOptions: {
|
|
1092
|
+
/** @default true */
|
|
1093
|
+
gitignore: boolean,
|
|
1094
|
+
},
|
|
1095
|
+
},
|
|
1096
|
+
|
|
1097
|
+
staticAssets: {
|
|
1098
|
+
/**
|
|
1099
|
+
* The directory underneath `/_nuxt/`, where static assets (payload, state and manifest files) will live.
|
|
1100
|
+
* @default "static"
|
|
1101
|
+
*/
|
|
1102
|
+
dir: string,
|
|
1103
|
+
|
|
1104
|
+
/**
|
|
1105
|
+
* The full path to the directory underneath `/_nuxt/` where static assets (payload, state and manifest files) will live.
|
|
1106
|
+
* @default "/home/runner/work/bridge/bridge/packages/bridge-schema/dist"
|
|
1107
|
+
*/
|
|
1108
|
+
base: string,
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* The full path to the versioned directory where static assets for the current build are located.
|
|
1112
|
+
* @default ""
|
|
1113
|
+
*/
|
|
1114
|
+
versionBase: string,
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* A unique string to uniquely identify payload versions (defaults to the current timestamp).
|
|
1118
|
+
* @default "1669994245"
|
|
1119
|
+
*/
|
|
1120
|
+
version: string,
|
|
1121
|
+
},
|
|
1122
|
+
},
|
|
1123
|
+
|
|
1124
|
+
messages: {
|
|
1125
|
+
/**
|
|
1126
|
+
* The text that displays on the Nuxt loading indicator when `ssr: false`.
|
|
1127
|
+
* @default "Loading..."
|
|
1128
|
+
*/
|
|
1129
|
+
loading: string,
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* The 404 text on the default Nuxt error page.
|
|
1133
|
+
* @default "This page could not be found"
|
|
1134
|
+
*/
|
|
1135
|
+
error_404: string,
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* The text to display on the default Nuxt error page when there has been a server error.
|
|
1139
|
+
* @default "Server error"
|
|
1140
|
+
*/
|
|
1141
|
+
server_error: string,
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* The text (linked to nuxtjs.org) that appears on the built-in Nuxt error page.
|
|
1145
|
+
* @default "Nuxt"
|
|
1146
|
+
*/
|
|
1147
|
+
nuxtjs: string,
|
|
1148
|
+
|
|
1149
|
+
/**
|
|
1150
|
+
* The text (linked to the home page) that appears on the built-in Nuxt error page.
|
|
1151
|
+
* @default "Back to the home page"
|
|
1152
|
+
*/
|
|
1153
|
+
back_to_home: string,
|
|
1154
|
+
|
|
1155
|
+
/**
|
|
1156
|
+
* The message that will display on a white screen if the built-in Nuxt error page can't be rendered.
|
|
1157
|
+
* @default "An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details."
|
|
1158
|
+
*/
|
|
1159
|
+
server_error_details: string,
|
|
1160
|
+
|
|
1161
|
+
/**
|
|
1162
|
+
* The default error title (if there isn't a specific error message) on the built-in Nuxt error page.
|
|
1163
|
+
* @default "Error"
|
|
1164
|
+
*/
|
|
1165
|
+
client_error: string,
|
|
1166
|
+
|
|
1167
|
+
/**
|
|
1168
|
+
* The error message (in debug mode) on the built-in Nuxt error page.
|
|
1169
|
+
* @default "An error occurred while rendering the page. Check developer tools console for details."
|
|
1170
|
+
*/
|
|
1171
|
+
client_error_details: string,
|
|
1172
|
+
},
|
|
1173
|
+
|
|
1174
|
+
render: {
|
|
1175
|
+
/**
|
|
1176
|
+
* Use this option to customize the Vue SSR bundle renderer. This option is skipped if `ssr: false`.
|
|
1177
|
+
* Read [docs for Vue 2](https://ssr.vuejs.org/api/#renderer-options) here.
|
|
1178
|
+
*/
|
|
1179
|
+
bundleRenderer: {
|
|
1180
|
+
shouldPrefetch: () => any,
|
|
1181
|
+
|
|
1182
|
+
shouldPreload: () => any,
|
|
1183
|
+
|
|
1184
|
+
/** enabled by default for development */
|
|
1185
|
+
runInNewContext: any,
|
|
1186
|
+
},
|
|
1187
|
+
|
|
1188
|
+
/** Configure the crossorigin attribute on `<link rel="stylesheet">` and `<script>` tags in generated HTML. [More information](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin). */
|
|
1189
|
+
crossorigin: any,
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
* Adds prefetch and preload links for faster initial page load time. You probably don't want to disable this option unless you have many pages and routes.
|
|
1193
|
+
* @default true
|
|
1194
|
+
*/
|
|
1195
|
+
resourceHints: boolean,
|
|
1196
|
+
|
|
1197
|
+
/**
|
|
1198
|
+
* Whether to enable rendering of HTML - either dynamically (in server mode) or at generate time.
|
|
1199
|
+
* This option is automatically set based on global SSR value if not provided. This can be useful to dynamically enable/disable SSR at runtime after image builds (with docker, for example).
|
|
1200
|
+
*/
|
|
1201
|
+
ssr: any,
|
|
1202
|
+
|
|
1203
|
+
/**
|
|
1204
|
+
* Forward server-side logs to the browser for better debugging (only available in development).
|
|
1205
|
+
* Set to `collapsed` to collapse the logs, or `false` to disable.
|
|
1206
|
+
* @default false
|
|
1207
|
+
*/
|
|
1208
|
+
ssrLog: boolean,
|
|
1209
|
+
|
|
1210
|
+
/** Configuration for HTTP2 push headers. */
|
|
1211
|
+
http2: {
|
|
1212
|
+
/**
|
|
1213
|
+
* Set to true to enable HTTP2 push headers.
|
|
1214
|
+
* @default false
|
|
1215
|
+
*/
|
|
1216
|
+
push: boolean,
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
*
|
|
1220
|
+
* @deprecated
|
|
1221
|
+
*/
|
|
1222
|
+
shouldPush: any,
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* You can control what links to push using this function. It receives `req`, `res`, `publicPath` and a `preloadFiles` array.
|
|
1226
|
+
* You can add your own assets to the array as well. Using `req` and `res` you can decide what links to push based on the request headers, for example using the cookie with application version.
|
|
1227
|
+
* Assets will be joined together with `,` and passed as a single `Link` header.
|
|
1228
|
+
*
|
|
1229
|
+
* @example
|
|
1230
|
+
* ```js
|
|
1231
|
+
* pushAssets: (req, res, publicPath, preloadFiles) =>
|
|
1232
|
+
* preloadFiles
|
|
1233
|
+
* .filter(f => f.asType === 'script' && f.file === 'runtime.js')
|
|
1234
|
+
* .map(f => `<${publicPath}${f.file}>; rel=preload; as=${f.asType}`)
|
|
1235
|
+
* ```
|
|
1236
|
+
*/
|
|
1237
|
+
pushAssets: any,
|
|
1238
|
+
},
|
|
1239
|
+
|
|
1240
|
+
/**
|
|
1241
|
+
* Configure the behavior of the `static/` directory.
|
|
1242
|
+
* See [serve-static docs](https://github.com/expressjs/serve-static) for possible options.
|
|
1243
|
+
*/
|
|
1244
|
+
static: {
|
|
1245
|
+
/**
|
|
1246
|
+
* Whether to add the router base to your static assets.
|
|
1247
|
+
* @default true
|
|
1248
|
+
*
|
|
1249
|
+
* @note some URL rewrites might not respect the prefix.
|
|
1250
|
+
*
|
|
1251
|
+
* @example
|
|
1252
|
+
* Assets: favicon.ico
|
|
1253
|
+
* Router base: /t
|
|
1254
|
+
* With `prefix: true` (default): /t/favicon.ico
|
|
1255
|
+
* With `prefix: false`: /favicon.ico
|
|
1256
|
+
*/
|
|
1257
|
+
prefix: boolean,
|
|
1258
|
+
},
|
|
1259
|
+
|
|
1260
|
+
/**
|
|
1261
|
+
* Configure server compression.
|
|
1262
|
+
* Set to `false` to disable compression. You can also pass an object of options for [compression middleware](https://www.npmjs.com/package/compression), or use your own middleware by passing it in directly - for example, `otherComp({ myOptions: 'example' })`.
|
|
1263
|
+
*/
|
|
1264
|
+
compressor: boolean | object | Function,
|
|
1265
|
+
|
|
1266
|
+
/**
|
|
1267
|
+
* To disable etag for pages set `etag: false`. See [etag docs](https://github.com/jshttp/etag) for possible options. You can use your own hash function by specifying etag.hash:
|
|
1268
|
+
*
|
|
1269
|
+
* @example
|
|
1270
|
+
* ```js
|
|
1271
|
+
* import { murmurHash128 } from 'murmurhash-native'
|
|
1272
|
+
*
|
|
1273
|
+
* export default {
|
|
1274
|
+
* render: {
|
|
1275
|
+
* etag: {
|
|
1276
|
+
* hash: html => murmurHash128(html)
|
|
1277
|
+
* }
|
|
1278
|
+
* }
|
|
1279
|
+
* }
|
|
1280
|
+
* ```
|
|
1281
|
+
* In this example we are using `murmurhash-native`, which is faster
|
|
1282
|
+
* for larger HTML body sizes. Note that the weak option is ignored
|
|
1283
|
+
* when specifying your own hash function.
|
|
1284
|
+
*/
|
|
1285
|
+
etag: {
|
|
1286
|
+
/** @default false */
|
|
1287
|
+
hash: boolean,
|
|
1288
|
+
|
|
1289
|
+
/** @default false */
|
|
1290
|
+
weak: boolean,
|
|
1291
|
+
},
|
|
1292
|
+
|
|
1293
|
+
/**
|
|
1294
|
+
* Use this to configure Content-Security-Policy to load external resources. [Read more](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).
|
|
1295
|
+
* Set to `true` to enable, or you can pass options to fine-tune your CSP options.
|
|
1296
|
+
* **Prerequisites**: These CSP settings are only effective when using Nuxt with `mode: 'server'` to serve your SSR application.
|
|
1297
|
+
* **Updating settings**: These settings are read by the Nuxt server directly from `nuxt.config`. This means changes to these settings take effect when the server is restarted. There is no need to rebuild the application to update CSP settings.
|
|
1298
|
+
* @default false
|
|
1299
|
+
*
|
|
1300
|
+
* @example
|
|
1301
|
+
* ```js
|
|
1302
|
+
* export default {
|
|
1303
|
+
* render: {
|
|
1304
|
+
* csp: {
|
|
1305
|
+
* hashAlgorithm: 'sha256',
|
|
1306
|
+
* policies: {
|
|
1307
|
+
* 'script-src': [
|
|
1308
|
+
* 'https://www.google-analytics.com',
|
|
1309
|
+
* 'https://name.example.com'
|
|
1310
|
+
* ],
|
|
1311
|
+
* 'report-uri': ['https://report.example.com/report-csp-violations']
|
|
1312
|
+
* },
|
|
1313
|
+
* addMeta: true
|
|
1314
|
+
* }
|
|
1315
|
+
* }
|
|
1316
|
+
* }
|
|
1317
|
+
* ```
|
|
1318
|
+
*
|
|
1319
|
+
* The following example allows Google Analytics, LogRocket.io, and Sentry.io
|
|
1320
|
+
* for logging and analytic tracking.
|
|
1321
|
+
*
|
|
1322
|
+
* Review [this blog on Sentry.io](https://blog.sentry.io/2018/09/04/how-sentry-captures-csp-violations)
|
|
1323
|
+
* to learn what tracking link you should use.
|
|
1324
|
+
*
|
|
1325
|
+
* @example
|
|
1326
|
+
* ```js
|
|
1327
|
+
* // PRIMARY_HOSTS = `loc.example-website.com`
|
|
1328
|
+
* export default {
|
|
1329
|
+
* render: {
|
|
1330
|
+
* csp: {
|
|
1331
|
+
* reportOnly: true,
|
|
1332
|
+
* hashAlgorithm: 'sha256',
|
|
1333
|
+
* policies: {
|
|
1334
|
+
* 'default-src': ["'self'"],
|
|
1335
|
+
* 'img-src': ['https:', '*.google-analytics.com'],
|
|
1336
|
+
* 'worker-src': ["'self'", `blob:`, PRIMARY_HOSTS, '*.logrocket.io'],
|
|
1337
|
+
* 'style-src': ["'self'", "'unsafe-inline'", PRIMARY_HOSTS],
|
|
1338
|
+
* 'script-src': [
|
|
1339
|
+
* "'self'",
|
|
1340
|
+
* "'unsafe-inline'",
|
|
1341
|
+
* PRIMARY_HOSTS,
|
|
1342
|
+
* 'sentry.io',
|
|
1343
|
+
* '*.sentry-cdn.com',
|
|
1344
|
+
* '*.google-analytics.com',
|
|
1345
|
+
* '*.logrocket.io'
|
|
1346
|
+
* ],
|
|
1347
|
+
* 'connect-src': [PRIMARY_HOSTS, 'sentry.io', '*.google-analytics.com'],
|
|
1348
|
+
* 'form-action': ["'self'"],
|
|
1349
|
+
* 'frame-ancestors': ["'none'"],
|
|
1350
|
+
* 'object-src': ["'none'"],
|
|
1351
|
+
* 'base-uri': [PRIMARY_HOSTS],
|
|
1352
|
+
* 'report-uri': [
|
|
1353
|
+
* `https://sentry.io/api/<project>/security/?sentry_key=<key>`
|
|
1354
|
+
* ]
|
|
1355
|
+
* }
|
|
1356
|
+
* }
|
|
1357
|
+
* }
|
|
1358
|
+
* }
|
|
1359
|
+
* ```
|
|
1360
|
+
*/
|
|
1361
|
+
csp: boolean,
|
|
1362
|
+
|
|
1363
|
+
/**
|
|
1364
|
+
* Options used for serving distribution files. Only applicable in production.
|
|
1365
|
+
* See [serve-static docs](https://www.npmjs.com/package/serve-static) for possible options.
|
|
1366
|
+
*/
|
|
1367
|
+
dist: {
|
|
1368
|
+
/** @default false */
|
|
1369
|
+
index: boolean,
|
|
1370
|
+
|
|
1371
|
+
/** @default "1y" */
|
|
1372
|
+
maxAge: string,
|
|
1373
|
+
},
|
|
1374
|
+
|
|
1375
|
+
/**
|
|
1376
|
+
* Configure fallback behavior for [`serve-placeholder` middleware](https://github.com/nuxt/serve-placeholder).
|
|
1377
|
+
* Example of allowing `.js` extension for routing (for example, `/repos/nuxt.js`):
|
|
1378
|
+
*
|
|
1379
|
+
* @example
|
|
1380
|
+
* ```js
|
|
1381
|
+
* export default {
|
|
1382
|
+
* render: {
|
|
1383
|
+
* fallback: {
|
|
1384
|
+
* static: {
|
|
1385
|
+
* // Avoid sending 404 for these extensions
|
|
1386
|
+
* handlers: {
|
|
1387
|
+
* '.js': false
|
|
1388
|
+
* }
|
|
1389
|
+
* }
|
|
1390
|
+
* }
|
|
1391
|
+
* }
|
|
1392
|
+
* }
|
|
1393
|
+
* ```
|
|
1394
|
+
*/
|
|
1395
|
+
fallback: {
|
|
1396
|
+
/** For routes matching the publicPath (`/_nuxt/*`). Disable by setting to `false`. */
|
|
1397
|
+
dist: any,
|
|
1398
|
+
|
|
1399
|
+
/** For all other routes (`/*`). Disable by setting to `false`. */
|
|
1400
|
+
static: {
|
|
1401
|
+
/** @default true */
|
|
1402
|
+
skipUnknown: boolean,
|
|
1403
|
+
|
|
1404
|
+
handlers: {
|
|
1405
|
+
/** @default false */
|
|
1406
|
+
".htm": boolean,
|
|
1407
|
+
|
|
1408
|
+
/** @default false */
|
|
1409
|
+
".html": boolean,
|
|
1410
|
+
},
|
|
1411
|
+
},
|
|
1412
|
+
},
|
|
1413
|
+
},
|
|
1414
|
+
|
|
1415
|
+
router: {
|
|
1416
|
+
/**
|
|
1417
|
+
* Configure the router mode.
|
|
1418
|
+
* For server-side rendering it is not recommended to change it.
|
|
1419
|
+
* @default "history"
|
|
1420
|
+
*/
|
|
1421
|
+
mode: string,
|
|
1422
|
+
|
|
1423
|
+
/**
|
|
1424
|
+
* The base URL of the app. For example, if the entire single page application is served under `/app/`, then base should use the value `'/app/'`.
|
|
1425
|
+
* This can be useful if you need to serve Nuxt as a different context root, from within a bigger web site.
|
|
1426
|
+
*/
|
|
1427
|
+
base: any,
|
|
1428
|
+
|
|
1429
|
+
/**
|
|
1430
|
+
* @default false
|
|
1431
|
+
*
|
|
1432
|
+
* @private
|
|
1433
|
+
*/
|
|
1434
|
+
_routerBaseSpecified: boolean,
|
|
1435
|
+
|
|
1436
|
+
routes: Array<any>,
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* This allows changing the separator between route names that Nuxt uses.
|
|
1440
|
+
* Imagine we have the page file `pages/posts/_id.vue`. Nuxt will generate the route name programmatically, in this case `posts-id`. If you change the routeNameSplitter config to `/` the name will change to `posts/id`.
|
|
1441
|
+
* @default "-"
|
|
1442
|
+
*/
|
|
1443
|
+
routeNameSplitter: string,
|
|
1444
|
+
|
|
1445
|
+
/** Set the default(s) middleware for every page of the application. */
|
|
1446
|
+
middleware: Array<any>,
|
|
1447
|
+
|
|
1448
|
+
/**
|
|
1449
|
+
* Globally configure `<nuxt-link>` default active class.
|
|
1450
|
+
* @default "nuxt-link-active"
|
|
1451
|
+
*/
|
|
1452
|
+
linkActiveClass: string,
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* Globally configure `<nuxt-link>` default exact active class.
|
|
1456
|
+
* @default "nuxt-link-exact-active"
|
|
1457
|
+
*/
|
|
1458
|
+
linkExactActiveClass: string,
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
* Globally configure `<nuxt-link>` default prefetch class (feature disabled by default).
|
|
1462
|
+
* @default false
|
|
1463
|
+
*/
|
|
1464
|
+
linkPrefetchedClass: boolean,
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* You can pass a function to extend the routes created by Nuxt.
|
|
1468
|
+
*
|
|
1469
|
+
* @example
|
|
1470
|
+
* ```js
|
|
1471
|
+
* import { fileURLToPath } from 'url'
|
|
1472
|
+
* export default {
|
|
1473
|
+
* router: {
|
|
1474
|
+
* extendRoutes(routes, resolve) {
|
|
1475
|
+
* routes.push({
|
|
1476
|
+
* name: 'custom',
|
|
1477
|
+
* path: '*',
|
|
1478
|
+
* component: fileURLToPath(new URL('./pages/404.vue', import.meta.url))
|
|
1479
|
+
* })
|
|
1480
|
+
* }
|
|
1481
|
+
* }
|
|
1482
|
+
* }
|
|
1483
|
+
* ```
|
|
1484
|
+
*/
|
|
1485
|
+
extendRoutes: any,
|
|
1486
|
+
|
|
1487
|
+
/**
|
|
1488
|
+
* The `scrollBehavior` option lets you define a custom behavior for the scroll position between the routes. This method is called every time a page is rendered. To learn more about it, see the `vue-router` documentation.
|
|
1489
|
+
*
|
|
1490
|
+
* @deprecated router.scrollBehavior` property is deprecated in favor of using `~/app/router.scrollBehavior.js` file, learn more: https://nuxtjs.org/api/configuration-router#scrollbehavior
|
|
1491
|
+
*
|
|
1492
|
+
* @see [vue-router `scrollBehavior` documentation](https://router.vuejs.org/guide/advanced/scroll-behavior.html).
|
|
1493
|
+
*/
|
|
1494
|
+
scrollBehavior: any,
|
|
1495
|
+
|
|
1496
|
+
/**
|
|
1497
|
+
* Provide custom query string parse function. Overrides the default.
|
|
1498
|
+
* @default false
|
|
1499
|
+
*/
|
|
1500
|
+
parseQuery: boolean,
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* Provide custom query string stringify function. Overrides the default.
|
|
1504
|
+
* @default false
|
|
1505
|
+
*/
|
|
1506
|
+
stringifyQuery: boolean,
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* Controls whether the router should fall back to hash mode when the browser does not support history.pushState, but mode is set to history.
|
|
1510
|
+
* Setting this to `false` essentially makes every router-link navigation a full page refresh in IE9. This is useful when the app is server-rendered and needs to work in IE9, because a hash mode URL does not work with SSR.
|
|
1511
|
+
* @default false
|
|
1512
|
+
*/
|
|
1513
|
+
fallback: boolean,
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* Configure `<nuxt-link>` to prefetch the code-splitted page when detected within the viewport. Requires [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to be supported (see [Caniuse](https://caniuse.com/intersectionobserver)).
|
|
1517
|
+
* @default true
|
|
1518
|
+
*/
|
|
1519
|
+
prefetchLinks: boolean,
|
|
1520
|
+
|
|
1521
|
+
/**
|
|
1522
|
+
* When using `nuxt generate` with target: 'static', Nuxt will generate a payload.js for each page.
|
|
1523
|
+
* With this option enabled, Nuxt will automatically prefetch the payload of the linked page when the `<nuxt-link>` is visible in the viewport, making instant navigation.
|
|
1524
|
+
* @default true
|
|
1525
|
+
*/
|
|
1526
|
+
prefetchPayloads: boolean,
|
|
1527
|
+
|
|
1528
|
+
/**
|
|
1529
|
+
* If this option is set to `true`, trailing slashes will be appended to every route. If set to `false`, they'll be removed.
|
|
1530
|
+
*
|
|
1531
|
+
* @warning This option should not be set without preparation and has to
|
|
1532
|
+
* be tested thoroughly. When setting `trailingSlash` to something else than
|
|
1533
|
+
* `undefined`, the opposite route will stop working. Thus, 301 redirects should
|
|
1534
|
+
* be in place and your internal linking has to be adapted correctly. If you set
|
|
1535
|
+
* `trailingSlash` to `true`, then only `example.com/abc/` will work, but not
|
|
1536
|
+
* `example.com/abc`. On `false`, it's vice-versa.
|
|
1537
|
+
*/
|
|
1538
|
+
trailingSlash: any,
|
|
1539
|
+
},
|
|
1540
|
+
|
|
1541
|
+
server: {
|
|
1542
|
+
/**
|
|
1543
|
+
* Whether to enable HTTPS.
|
|
1544
|
+
* @default false
|
|
1545
|
+
*
|
|
1546
|
+
* @example
|
|
1547
|
+
* ```
|
|
1548
|
+
* import { fileURLToPath } from 'node:url'
|
|
1549
|
+
* export default {
|
|
1550
|
+
* server: {
|
|
1551
|
+
* https: {
|
|
1552
|
+
* key: fs.readFileSync(fileURLToPath(new URL('./server.key', import.meta.url))),
|
|
1553
|
+
* cert: fs.readFileSync(fileURLToPath(new URL('./server.crt', import.meta.url)))
|
|
1554
|
+
* }
|
|
1555
|
+
* }
|
|
1556
|
+
* }
|
|
1557
|
+
* ```
|
|
1558
|
+
*/
|
|
1559
|
+
https: false | { key: string; cert: string },
|
|
1560
|
+
|
|
1561
|
+
/** @default 3000 */
|
|
1562
|
+
port: number,
|
|
1563
|
+
|
|
1564
|
+
/** @default "localhost" */
|
|
1565
|
+
host: string,
|
|
1566
|
+
|
|
1567
|
+
socket: any,
|
|
1568
|
+
|
|
1569
|
+
/**
|
|
1570
|
+
* Enabling timing adds a middleware to measure the time elapsed during server-side rendering and adds it to the headers as 'Server-Timing'.
|
|
1571
|
+
* Apart from true/false, this can be an object for providing options. Currently, only `total` is supported (which directly tracks the whole time spent on server-side rendering.
|
|
1572
|
+
*/
|
|
1573
|
+
timing: () => any,
|
|
1574
|
+
},
|
|
1575
|
+
}
|