Skip to content

Interface: OutputOptions

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:214

Properties

advancedChunks?

ts
optional advancedChunks: object;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:380

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

groups?

ts
optional groups: object[];

Groups to be used for advanced chunking.

includeDependenciesRecursively?

ts
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?

ts
optional maxModuleSize: number;
  • Type: number

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

maxSize?

ts
optional maxSize: number;
  • Type: number

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

minModuleSize?

ts
optional minModuleSize: number;
  • Type: number

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

minShareCount?

ts
optional minShareCount: number;
  • Type: number

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

minSize?

ts
optional minSize: number;
  • Type: number

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


assetFileNames?

ts
optional assetFileNames: string | AssetFileNamesFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:279


ts
optional banner: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:265


chunkFileNames?

ts
optional chunkFileNames:
  | string
  | ChunkFileNamesFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:281


cleanDir?

ts
optional cleanDir: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:595

  • Type: boolean
  • Default: false

Clean output directory before emitting output.


cssChunkFileNames?

ts
optional cssChunkFileNames:
  | string
  | ChunkFileNamesFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:283


cssEntryFileNames?

ts
optional cssEntryFileNames:
  | string
  | ChunkFileNamesFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:282


dir?

ts
optional dir: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:215


entryFileNames?

ts
optional entryFileNames:
  | string
  | ChunkFileNamesFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:280


esModule?

ts
optional esModule: boolean | "if-default-prop";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:278


exports?

ts
optional exports: "default" | "auto" | "named" | "none";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:217


extend?

ts
optional extend: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:277


externalLiveBindings?

ts
optional externalLiveBindings: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:330


file?

ts
optional file: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:216


ts
optional footer: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:266


format?

ts
optional format: ModuleFormat;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:228

Expected format of generated code.

Default

ts
'esm'

generatedCode?

ts
optional generatedCode: Partial<GeneratedCodeOptions>;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:329


globals?

ts
optional globals:
  | Record<string, string>
  | GlobalsFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:297


hashCharacters?

ts
optional hashCharacters: "base64" | "hex" | "base36";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:218


hoistTransitiveImports?

ts
optional hoistTransitiveImports: false;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:577


inlineDynamicImports?

ts
optional inlineDynamicImports: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:331


intro?

ts
optional intro: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:275


keepNames?

ts
optional keepNames: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:603

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

ts
false

legalComments?

ts
optional legalComments: "inline" | "none";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:574

Control comments in the output.

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

manualChunks?

ts
optional manualChunks: ManualChunksFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:376

  • 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,

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

will be transformed to

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

Deprecated

Please use advancedChunks instead.


minify?

ts
optional minify:
  | boolean
  | MinifyOptions
  | "dce-only";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:295

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

ts
false

minifyInternalExports?

ts
optional minifyInternalExports: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:588

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

Whether to minify internal exports.


name?

ts
optional name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:296


outro?

ts
optional outro: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:276


paths?

ts
optional paths: Record<string, string> | PathsFunction$1;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:328

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

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

plugins?

ts
optional plugins: RolldownOutputPluginOption;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:575


polyfillRequire?

ts
optional polyfillRequire: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:576


postBanner?

ts
optional postBanner: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:270

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


postFooter?

ts
optional postFooter: string | AddonFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:274

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


preserveModules?

ts
optional preserveModules: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:578


preserveModulesRoot?

ts
optional preserveModulesRoot: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:580


sanitizeFileName?

ts
optional sanitizeFileName: boolean | SanitizeFileNameFunction;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:284


sourcemap?

ts
optional sourcemap: boolean | "hidden" | "inline";

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:229


sourcemapBaseUrl?

ts
optional sourcemapBaseUrl: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:230


sourcemapDebugIds?

ts
optional sourcemapDebugIds: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:231


sourcemapIgnoreList?

ts
optional sourcemapIgnoreList:
  | boolean
  | StringOrRegExp
  | SourcemapIgnoreListOption;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:263

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

js
// ✅ 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?

ts
optional sourcemapPathTransform: SourcemapPathTransformOption;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:264


topLevelVar?

ts
optional topLevelVar: boolean;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:581


virtualDirname?

ts
optional virtualDirname: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/rolldown/dist/shared/define-config-kYHtCO-M.d.mts:579

Released under the MIT License.