Interface: OutputOptions

Defined in: options/output-options.ts:101

Properties

advancedChunks?

• Type: optional advancedChunks: object

Defined in: options/output-options.ts:267

Allows you to do manual chunking. For deeper understanding, please refer to the in-depth documentation.

groups?

• Type: optional groups: object[]

Groups to be used for advanced chunking.

includeDependenciesRecursively?

• Type: optional includeDependenciesRecursively: boolean

• Type: boolean

• Default: true

By default, each group will also include captured modules' dependencies. This reduces the chance of generating circular chunks.

If you want to disable this behavior, it's recommended to both set

• preserveEntrySignatures: false | 'allow-extension'
• strictExecutionOrder: true

to avoid generating invalid chunks.

maxModuleSize?

• Type: optional maxModuleSize: number

• Type: number

Global fallback of {group}.maxModuleSize, if it's not specified in the group.

maxSize?

• Type: optional maxSize: number

• Type: number

Global fallback of {group}.maxSize, if it's not specified in the group.

minModuleSize?

• Type: optional minModuleSize: number

• Type: number

Global fallback of {group}.minModuleSize, if it's not specified in the group.

minShareCount?

• Type: optional minShareCount: number

• Type: number

Global fallback of {group}.minShareCount, if it's not specified in the group.

minSize?

• Type: optional minSize: number

• Type: number

Global fallback of {group}.minSize, if it's not specified in the group.

---

assetFileNames?

• Type: optional assetFileNames: string | AssetFileNamesFunction

Defined in: options/output-options.ts:166

---

banner?

• Type: optional banner: string | AddonFunction

Defined in: options/output-options.ts:152

---

chunkFileNames?

• Type: optional chunkFileNames: string | ChunkFileNamesFunction

Defined in: options/output-options.ts:168

---

cleanDir?

• Type: optional cleanDir: boolean

Defined in: options/output-options.ts:484

• Type: boolean
• Default: false

Clean output directory before emitting output.

---

cssChunkFileNames?

• Type: optional cssChunkFileNames: string | ChunkFileNamesFunction

Defined in: options/output-options.ts:170

---

cssEntryFileNames?

• Type: optional cssEntryFileNames: string | ChunkFileNamesFunction

Defined in: options/output-options.ts:169

---

dir?

• Type: optional dir: string

Defined in: options/output-options.ts:102

---

entryFileNames?

• Type: optional entryFileNames: string | ChunkFileNamesFunction

Defined in: options/output-options.ts:167

---

esModule?

• Type: optional esModule: boolean | "if-default-prop"

Defined in: options/output-options.ts:165

---

exports?

• Type: optional exports: "auto" | "named" | "default" | "none"

Defined in: options/output-options.ts:104

---

extend?

• Type: optional extend: boolean

Defined in: options/output-options.ts:164

---

externalLiveBindings?

• Type: optional externalLiveBindings: boolean

Defined in: options/output-options.ts:217

---

file?

• Type: optional file: string

Defined in: options/output-options.ts:103

---

footer?

• Type: optional footer: string | AddonFunction

Defined in: options/output-options.ts:153

---

format?

• Type: optional format: ModuleFormat

Defined in: options/output-options.ts:115

Expected format of generated code.

• 'es', 'esm' and 'module' are the same format, all stand for ES module.
• 'cjs' and 'commonjs' are the same format, all stand for CommonJS module.
• 'iife' stands for Immediately Invoked Function Expression.
• 'umd' stands for Universal Module Definition.

Default

'esm'

---

generatedCode?

• Type: optional generatedCode: Partial<GeneratedCodeOptions>

Defined in: options/output-options.ts:216

---

globals?

• Type: optional globals: Record<string, string> | GlobalsFunction

Defined in: options/output-options.ts:184

---

hashCharacters?

• Type: optional hashCharacters: "base64" | "base36" | "hex"

Defined in: options/output-options.ts:105

---

hoistTransitiveImports?

• Type: optional hoistTransitiveImports: false

Defined in: options/output-options.ts:466

---

inlineDynamicImports?

• Type: optional inlineDynamicImports: boolean

Defined in: options/output-options.ts:218

---

intro?

• Type: optional intro: string | AddonFunction

Defined in: options/output-options.ts:162

---

keepNames?

• Type: optional keepNames: boolean

Defined in: options/output-options.ts:492

Keep function and class names after bundling.

When enabled, the bundler will preserve the original names of functions and classes in the output, which is useful for debugging and error stack traces.

Default

false

---

legalComments?

• Type: optional legalComments: "none" | "inline"

Defined in: options/output-options.ts:463

Control comments in the output.

• none: no comments
• inline: preserve comments that contain @license, @preserve or starts with //! /*!

---

manualChunks?

• Type: optional manualChunks: ManualChunksFunction

Defined in: options/output-options.ts:263

• Type: ((moduleId: string, meta: { getModuleInfo: (moduleId: string) => ModuleInfo | null }) => string | NullValue)
• Object form is not supported.

WARNING

• This option is deprecated. Please use advancedChunks instead.
• If manualChunks and advancedChunks are both specified, manualChunks option will be ignored.

You could use this option for migration purpose. Under the hood,

{
  manualChunks: (moduleId, meta) => {
    if (moduleId.includes('node_modules')) {
      return 'vendor';
    }
    return null;
  }
}

will be transformed to

{
  advancedChunks: {
    groups: [
      {
        name(moduleId) {
          if (moduleId.includes('node_modules')) {
            return 'vendor';
          }
          return null;
        },
      },
    ],
  }
}

Deprecated

Please use advancedChunks instead.

---

minify?

• Type: optional minify: boolean | MinifyOptions | "dce-only"

Defined in: options/output-options.ts:182

Control code minification.

• true: Enable full minification including code compression and dead code elimination
• false: Disable minification (default)
• 'dce-only': Only perform dead code elimination without code compression
• MinifyOptions: Fine-grained control over minification settings

Default

false

---

minifyInternalExports?

• Type: optional minifyInternalExports: boolean

Defined in: options/output-options.ts:477

• Type: boolean
• Default: true for format es or if output.minify is true or object, false otherwise

Whether to minify internal exports.

---

name?

• Type: optional name: string

Defined in: options/output-options.ts:183

---

outro?

• Type: optional outro: string | AddonFunction

Defined in: options/output-options.ts:163

---

paths?

• Type: optional paths: Record<string, string> | PathsFunction

Defined in: options/output-options.ts:215

Maps external module IDs to paths.

Allows customizing the path used when importing external dependencies. This is particularly useful for loading dependencies from CDNs or custom locations.

• Object form: Maps module IDs to their replacement paths
• Function form: Takes a module ID and returns its replacement path

Examples

{
  paths: {
    'd3': 'https://cdn.jsdelivr.net/npm/d3@7'
  }
}

{
  paths: (id) => {
    if (id.startsWith('lodash')) {
      return `https://cdn.jsdelivr.net/npm/${id}`
    }
    return id
  }
}

---

plugins?

• Type: optional plugins: RolldownOutputPluginOption

Defined in: options/output-options.ts:464

---

polyfillRequire?

• Type: optional polyfillRequire: boolean

Defined in: options/output-options.ts:465

---

postBanner?

• Type: optional postBanner: string | AddonFunction

Defined in: options/output-options.ts:157

Similar to banner option, but will run after the renderChunk hook and builtin minification.

---

postFooter?

• Type: optional postFooter: string | AddonFunction

Defined in: options/output-options.ts:161

Similar to footer option, but will run after the renderChunk hook and builtin minification.

---

preserveModules?

• Type: optional preserveModules: boolean

Defined in: options/output-options.ts:467

---

preserveModulesRoot?

• Type: optional preserveModulesRoot: string

Defined in: options/output-options.ts:469

---

sanitizeFileName?

• Type: optional sanitizeFileName: boolean | SanitizeFileNameFunction

Defined in: options/output-options.ts:171

---

sourcemap?

• Type: optional sourcemap: boolean | "inline" | "hidden"

Defined in: options/output-options.ts:116

---

sourcemapBaseUrl?

• Type: optional sourcemapBaseUrl: string

Defined in: options/output-options.ts:117

---

sourcemapDebugIds?

• Type: optional sourcemapDebugIds: boolean

Defined in: options/output-options.ts:118

---

sourcemapIgnoreList?

• Type: optional sourcemapIgnoreList: boolean | StringOrRegExp | SourcemapIgnoreListOption

Defined in: options/output-options.ts:150

Control which source files are included in the sourcemap ignore list. Files in the ignore list are excluded from debugger stepping and error stack traces.

• false: Include all source files in the ignore list
• true: Include no source files in the ignore list
• string: Files containing this string in their path will be included in the ignore list
• RegExp: Files matching this regular expression will be included in the ignore list
• function: Custom function (source: string, sourcemapPath: string) => boolean to determine if a source should be ignored

Performance

Using static values (boolean, string, or RegExp) is significantly more performant than functions. Calling JavaScript functions from Rust has extremely high overhead, so prefer static patterns when possible.

Examples

// ✅ Preferred: Use RegExp for better performance
sourcemapIgnoreList: /node_modules/

// ✅ Preferred: Use string pattern for better performance
sourcemapIgnoreList: "vendor"

// ! Use sparingly: Function calls have high overhead
sourcemapIgnoreList: (source, sourcemapPath) => {
  return source.includes('node_modules') || source.includes('.min.');
}

default: /node_modules/

---

sourcemapPathTransform?

• Type: optional sourcemapPathTransform: SourcemapPathTransformOption

Defined in: options/output-options.ts:151

---

topLevelVar?

• Type: optional topLevelVar: boolean

Defined in: options/output-options.ts:470

---

virtualDirname?

• Type: optional virtualDirname: string

Defined in: options/output-options.ts:468