Interface ResolvedBuildOptions

Make all properties in T required

interface ResolvedBuildOptions {
    assetsDir: string;
    assetsInlineLimit: number | ((filePath, content) => undefined | boolean);
    chunkSizeWarningLimit: number;
    commonjsOptions: RollupCommonJSOptions;
    copyPublicDir: boolean;
    cssCodeSplit: boolean;
    cssMinify: boolean | "esbuild" | "lightningcss";
    cssTarget: undefined | string | false | string[];
    dynamicImportVarsOptions: RollupDynamicImportVarsOptions;
    emptyOutDir: null | boolean;
    lib: false | LibraryOptions;
    manifest: string | boolean;
    minify: boolean | "esbuild" | "terser";
    modulePreload: false | ResolvedModulePreloadOptions;
    outDir: string;
    reportCompressedSize: boolean;
    rollupOptions: RollupOptions;
    sourcemap: boolean | "inline" | "hidden";
    ssr: string | boolean;
    ssrEmitAssets: boolean;
    ssrManifest: string | boolean;
    target: undefined | string | false | string[];
    terserOptions: TerserOptions;
    watch: null | WatcherOptions;
    write: boolean;
}

Hierarchy (view full)

Properties

assetsDir assetsInlineLimit chunkSizeWarningLimit commonjsOptions copyPublicDir cssCodeSplit cssMinify cssTarget dynamicImportVarsOptions emptyOutDir lib manifest minify modulePreload outDir reportCompressedSize rollupOptions sourcemap ssr ssrEmitAssets ssrManifest target terserOptions watch write

Properties

assetsDir

assetsDir: string

Directory relative from outDir where the built js/css/image assets will be placed.

Default

'assets'

assetsInlineLimit

assetsInlineLimit: number | ((filePath, content) => undefined | boolean)

Static asset files smaller than this number (in bytes) will be inlined as base64 strings. Default limit is 4096 (4 KiB). Set to 0 to disable.

Type declaration

    • (filePath, content): undefined | boolean

    • Parameters

      • filePath: string
      • content: Buffer

      Returns undefined | boolean

Default

4096

chunkSizeWarningLimit

chunkSizeWarningLimit: number

Adjust chunk size warning limit (in kB).

Default

500

commonjsOptions

commonjsOptions: RollupCommonJSOptions

Options to pass on to @rollup/plugin-commonjs

copyPublicDir

copyPublicDir: boolean

Copy the public directory to outDir on write.

Default

true

cssCodeSplit

cssCodeSplit: boolean

Whether to code-split CSS. When enabled, CSS in async chunks will be inlined as strings in the chunk and inserted via dynamically created style tags when the chunk is loaded.

Default

true

cssMinify

cssMinify: boolean | "esbuild" | "lightningcss"

Override CSS minification specifically instead of defaulting to build.minify, so you can configure minification for JS and CSS separately.

Default

'esbuild'

cssTarget

cssTarget: undefined | string | false | string[]

An optional separate target for CSS minification. As esbuild only supports configuring targets to mainstream browsers, users may need this option when they are targeting a niche browser that comes with most modern JavaScript features but has poor CSS support, e.g. Android WeChat WebView, which doesn't support the #RGBA syntax.

Default

target

dynamicImportVarsOptions

dynamicImportVarsOptions: RollupDynamicImportVarsOptions

Options to pass on to @rollup/plugin-dynamic-import-vars

emptyOutDir

emptyOutDir: null | boolean

Empty outDir on write.

Default

true when outDir is a sub directory of project root

lib

lib: false | LibraryOptions

Build in library mode. The value should be the global name of the lib in UMD mode. This will produce esm + cjs + umd bundle formats with default configurations that are suitable for distributing libraries.

Default

false

manifest

manifest: string | boolean

Whether to emit a .vite/manifest.json under assets dir to map hash-less filenames to their hashed versions. Useful when you want to generate your own HTML instead of using the one generated by Vite.

Example:

{
  "main.js": {
    "file": "main.68fe3fad.js",
    "css": "main.e6b63442.css",
    "imports": [...],
    "dynamicImports": [...]
  }
}

Default

false

minify

minify: boolean | "esbuild" | "terser"

Set to false to disable minification, or specify the minifier to use. Available options are 'terser' or 'esbuild'.

Default

'esbuild'

modulePreload

modulePreload: false | ResolvedModulePreloadOptions

outDir

outDir: string

Directory relative from root where build output will be placed. If the directory exists, it will be removed before the build.

Default

'dist'

reportCompressedSize

reportCompressedSize: boolean

Set to false to disable reporting compressed chunk sizes. Can slightly improve build speed.

Default

true

rollupOptions

rollupOptions: RollupOptions

Will be merged with internal rollup options. https://rollupjs.org/configuration-options/

sourcemap

sourcemap: boolean | "inline" | "hidden"

If true, a separate sourcemap file will be created. If 'inline', the sourcemap will be appended to the resulting output file as data URI. 'hidden' works like true except that the corresponding sourcemap comments in the bundled files are suppressed.

Default

false

ssr

ssr: string | boolean

Produce SSR oriented build. Note this requires specifying SSR entry via rollupOptions.input.

Default

false

ssrEmitAssets

ssrEmitAssets: boolean

Emit assets during SSR.

Default

false

ssrManifest

ssrManifest: string | boolean

Generate SSR manifest for determining style links and asset preload directives in production.

Default

false

target

target: undefined | string | false | string[]

Compatibility transform target. The transform is performed with esbuild and the lowest supported target is es2015/es6. Note this only handles syntax transformation and does not cover polyfills (except for dynamic import)

Default: 'modules' - Similar to @babel/preset-env's targets.esmodules, transpile targeting browsers that natively support dynamic es module imports. https://caniuse.com/es6-module-dynamic-import

Another special value is 'esnext' - which only performs minimal transpiling (for minification compat) and assumes native dynamic imports support.

For custom targets, see https://esbuild.github.io/api/#target and https://esbuild.github.io/content-types/#javascript for more details.

Default

'modules'

terserOptions

terserOptions: TerserOptions

Options for terser https://terser.org/docs/api-reference#minify-options

In addition, you can also pass a maxWorkers: number option to specify the max number of workers to spawn. Defaults to the number of CPUs minus 1.

watch

watch: null | WatcherOptions

Rollup watch options https://rollupjs.org/configuration-options/#watch

Default

null

write

write: boolean

Whether to write bundle to disk

Default

true

Settings

Member Visibility

Theme

On This Page

assetsDirassetsInlineLimitchunkSizeWarningLimitcommonjsOptionscopyPublicDircssCodeSplitcssMinifycssTargetdynamicImportVarsOptionsemptyOutDirlibmanifestminifymodulePreloadoutDirreportCompressedSizerollupOptionssourcemapssrssrEmitAssetsssrManifesttargetterserOptionswatchwrite