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