Interface: Plugin<A>

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2769

The Plugin interface.

See Plugin API document for details.

Extends

OutputPlugin.Partial<PluginHooks>

Type Parameters

A

A = any

The type of the api property.

Properties

api?

optional api: A;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2773

Used for inter-plugin communication.

name

name: string

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2756

The name of the plugin, for use in error messages and logs.

Inherited from

OutputPlugin.name

version?

optional version: string;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2758

The version of the plugin, for use in inter-plugin communication scenarios.

Inherited from

OutputPlugin.version

Build Hooks

buildEnd?

optional buildEnd: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2563

Called when Rolldown has finished bundling, but before Output Generation Hooks. If an error occurred during the build, it is passed on to this hook.

Inherited from

FunctionPluginHooks.buildEnd

buildStart?

optional buildStart: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2492

Called on each rolldown() build.

This is the recommended hook to use when you need access to the options passed to rolldown() as it takes the transformations by all options hooks into account and also contains the right default values for unset options.

Inherited from

FunctionPluginHooks.buildStart

closeWatcher?

optional closeWatcher: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2677

Notifies a plugin when the watcher process will close so that all open resources can be closed too.

This hook cannot be used by output plugins.

Inherited from

FunctionPluginHooks.closeWatcher

load?

optional load: ObjectHook<(this, ...parameters) => MaybePromise<LoadResult> | Promise<MaybePromise<LoadResult>>, {
  filter?:   | TopLevelFilterExpression[]
     | Pick<HookFilter, "id">;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2529

Defines a custom loader.

Returning null defers to other load hooks or the built-in loading mechanism.

You can use this.getModuleInfo() to find out the previous values of meta, moduleSideEffects inside this hook.

Inherited from

FunctionPluginHooks.load

moduleParsed?

optional moduleParsed: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2556

This hook is called each time a module has been fully parsed by Rolldown.

This hook will wait until all imports are resolved so that the information in moduleInfo.importedIds, moduleInfo.dynamicallyImportedIds are complete and accurate. Note however that information about importing modules may be incomplete as additional importers could be discovered later. If you need this information, use the buildEnd hook.

Inherited from

FunctionPluginHooks.moduleParsed

onLog?

optional onLog: ObjectHook<(this, level, log) => boolean | NullValue<void>, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2458

A function that receives and filters logs and warnings generated by Rolldown and plugins before they are passed to the onLog option or printed to the console.

If false is returned, the log will be filtered out. Otherwise, the log will be handed to the onLog hook of the next plugin, the onLog option, or printed to the console. Plugins can also change the log level of a log or turn a log into an error by passing the log object to this.error, this.warn, this.info or this.debug and returning false.

./docs/plugin-hooks-onlog.md

Inherited from

FunctionPluginHooks.onLog

options?

optional options: ObjectHook<(this, ...parameters) => InputOptions | NullValue<void> | Promise<InputOptions | NullValue<void>>, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2470

Replaces or manipulates the options object passed to rolldown().

Returning null does not replace anything.

If you just need to read the options, it is recommended to use the buildStart hook as that hook has access to the options after the transformations from all options hooks have been taken into account.

Inherited from

FunctionPluginHooks.options

outputOptions?

optional outputOptions: ObjectHook<(this, options) => OutputOptions | NullValue<void>, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2484

Replaces or manipulates the output options object passed to bundle.generate() or bundle.write().

Returning null does not replace anything.

If you just need to read the output options, it is recommended to use the renderStart hook as this hook has access to the output options after the transformations from all outputOptions hooks have been taken into account.

Inherited from

FunctionPluginHooks.outputOptions

resolveDynamicImport?

optional resolveDynamicImport: ObjectHook<(this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2519

Defines a custom resolver for dynamic imports.

Deprecated

This hook exists only for Rollup compatibility. Please use resolveId instead.

Inherited from

FunctionPluginHooks.resolveDynamicImport

resolveId?

optional resolveId: ObjectHook<(this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>, {
  filter?:   | {
     id?: GeneralHookFilter<RegExp> | undefined;
   }
     | TopLevelFilterExpression[];
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2510

Defines a custom resolver.

A resolver can be useful for e.g. locating third-party dependencies.

Returning null defers to other resolveId hooks and eventually the default resolution behavior. Returning false signals that source should be treated as an external module and not included in the bundle. If this happens for a relative import, the id will be renormalized the same way as when the InputOptions.external option is used. If you return an object, then it is possible to resolve an import to a different id while excluding it from the bundle at the same time.

Note that while resolveId will be called for each import of a module and can therefore resolve to the same id many times, values for external, meta or moduleSideEffects can only be set once before the module is loaded. The reason is that after this call, Rolldown will continue with the load and transform hooks for that module that may override these values and should take precedence if they do so.

Inherited from

FunctionPluginHooks.resolveId

transform?

optional transform: ObjectHook<(this, ...parameters) => TransformResult | Promise<TransformResult>, {
  filter?:   | HookFilter
     | TopLevelFilterExpression[];
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2539

Can be used to transform individual modules.

Note that it's possible to return only properties and no code transformations.

You can use this.getModuleInfo() to find out the previous values of meta, moduleSideEffects inside this hook.

Inherited from

FunctionPluginHooks.transform

watchChange?

optional watchChange: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2667

Notifies a plugin whenever Rolldown has detected a change to a monitored file in watch mode.

If a build is currently running, this hook is called once the build finished. It will be called once for every file that changed.

This hook cannot be used by output plugins.

If you need to be notified immediately when a file changed, you can use the watch.onInvalidate option.

Inherited from

FunctionPluginHooks.watchChange

Output Generation Hooks

augmentChunkHash?

optional augmentChunkHash: ObjectHook<(this, chunk) => string | void, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2608

Can be used to augment the hash of individual chunks. Called for each Rolldown output chunk.

Returning a falsy value will not modify the hash. Truthy values will be used as an additional source for hash calculation.

./docs/plugin-hooks-augmentchunkhash.md

Inherited from

FunctionPluginHooks.augmentChunkHash

optional banner: ObjectHook<AddonHook, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2709

A hook equivalent to output.banner option.

Inherited from

OutputPlugin.banner

closeBundle?

optional closeBundle: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2654

Can be used to clean up any external service that may be running.

Rolldown's CLI will make sure this hook is called after each run, but it is the responsibility of users of the JavaScript API to manually call bundle.close() once they are done generating bundles. For that reason, any plugin relying on this feature should carefully mention this in its documentation.

If a plugin wants to retain resources across builds in watch mode, they can check for this.meta.watchMode in this hook and perform the necessary cleanup for watch mode in closeWatcher.

Inherited from

FunctionPluginHooks.closeBundle

optional footer: ObjectHook<AddonHook, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2715

A hook equivalent to output.footer option.

Inherited from

OutputPlugin.footer

generateBundle?

optional generateBundle: ObjectHook<(this, ...parameters) => void | Promise<void>, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2631

Called at the end of bundle.generate() or immediately before the files are written in bundle.write().

To modify the files after they have been written, use the writeBundle hook.

./docs/plugin-hooks-generatebundle.md

Inherited from

FunctionPluginHooks.generateBundle

intro?

optional intro: ObjectHook<AddonHook, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2721

A hook equivalent to output.intro option.

Inherited from

OutputPlugin.intro

outro?

optional outro: ObjectHook<AddonHook, {
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2727

A hook equivalent to output.outro option.

Inherited from

OutputPlugin.outro

renderChunk?

optional renderChunk: ObjectHook<(this, ...parameters) => string | NullValue<void> | BindingMagicString | { code: string | BindingMagicString; map?: SourceMapInput | undefined; } | Promise<...>, {
  filter?:   | TopLevelFilterExpression[]
     | Pick<HookFilter, "code">;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2594

Can be used to transform individual chunks. Called for each Rolldown output chunk file.

Returning null will apply no transformations. If you change code in this hook and want to support source maps, you need to return a map describing your changes, see Source Code Transformations section.

chunk is mutable and changes applied in this hook will propagate to other plugins and to the generated bundle. That means if you add or remove imports or exports in this hook, you should update imports, RenderedChunk.importedBindings | importedBindings and/or exports accordingly.

Inherited from

FunctionPluginHooks.renderChunk

renderError?

optional renderError: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2619

Called when Rolldown encounters an error during bundle.generate() or bundle.write().

To get notified when generation completes successfully, use the generateBundle hook.

Inherited from

FunctionPluginHooks.renderError

renderStart?

optional renderStart: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2581

Called initially each time bundle.generate() or bundle.write() is called.

To get notified when generation has completed, use the generateBundle and renderError hooks.

This is the recommended hook to use when you need access to the output options passed to bundle.generate() or bundle.write() as it takes the transformations by all outputOptions hooks into account and also contains the right default values for unset options.

It also receives the input options passed to rolldown() so that plugins that can be used as output plugins, i.e. plugins that only use generate phase hooks, can get access to them.

Inherited from

FunctionPluginHooks.renderStart

writeBundle?

optional writeBundle: ObjectHook<(this, ...parameters) => void | Promise<void>, {
  sequential?: boolean;
}>;

Defined in: node_modules/.pnpm/rolldown@1.0.0-rc.1/node_modules/rolldown/dist/shared/define-config-DO4TBkJV.d.mts:2638

Called only at the end of bundle.write() once all files have been written.

Inherited from

FunctionPluginHooks.writeBundle

Interface: Plugin<A> ​

Extends ​

Type Parameters ​

A ​

Properties ​

api? ​

name ​

Inherited from ​

version? ​

Inherited from ​

Build Hooks ​

buildEnd? ​

Inherited from ​

buildStart? ​

Inherited from ​

closeWatcher? ​

Inherited from ​

load? ​

Inherited from ​

moduleParsed? ​

Inherited from ​

onLog? ​

Inherited from ​

options? ​

Inherited from ​

outputOptions? ​

Inherited from ​

resolveDynamicImport? ​

Deprecated ​

Inherited from ​

resolveId? ​

Inherited from ​

transform? ​

Inherited from ​

watchChange? ​

Inherited from ​

Output Generation Hooks ​

augmentChunkHash? ​

Inherited from ​

banner? ​

Inherited from ​

closeBundle? ​

Inherited from ​

footer? ​

Inherited from ​

generateBundle? ​

Inherited from ​

intro? ​

Inherited from ​

outro? ​

Inherited from ​

renderChunk? ​

Inherited from ​

renderError? ​

Inherited from ​

renderStart? ​

Inherited from ​

writeBundle? ​

Inherited from ​

Interface: Plugin<A>

Extends

Type Parameters

A

Properties

api?

name

Inherited from

version?

Inherited from

Build Hooks

buildEnd?

Inherited from

buildStart?

Inherited from

closeWatcher?

Inherited from

load?

Inherited from

moduleParsed?

Inherited from

onLog?

Inherited from

options?

Inherited from

outputOptions?

Inherited from

resolveDynamicImport?

Deprecated

Inherited from

resolveId?

Inherited from

transform?

Inherited from

watchChange?

Inherited from

Output Generation Hooks

augmentChunkHash?

Inherited from

banner?

Inherited from

closeBundle?

Inherited from

footer?

Inherited from

generateBundle?

Inherited from

intro?

Inherited from

outro?

Inherited from

renderChunk?

Inherited from

renderError?

Inherited from

renderStart?

Inherited from

writeBundle?

Inherited from