KC's Workspace
    Preparing search index...
    interface MinimalPluginContext {
        debug: (
            log: string | RolldownLog | (() => string | RolldownLog),
        ) => void;
        error: (e: string | RolldownError) => never;
        info: (log: string | RolldownLog | (() => string | RolldownLog)) => void;
        meta: PluginContextMeta;
        warn: (log: string | RolldownLog | (() => string | RolldownLog)) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Logging Methods

    Properties

    An object containing potentially useful metadata.

    Logging Methods

    debug: (log: string | RolldownLog | (() => string | RolldownLog)) => void

    Generate a "debug" level log.

    code will be set to "PLUGIN_LOG" by Rolldown. Make sure to add a distinctive pluginCode to those logs for easy filtering.

    error: (e: string | RolldownError) => never

    Similar to this.warn, except that it will also abort the bundling process with an error.

    If an Error instance is passed, it will be used as-is, otherwise a new Error instance will be created with the given error message and all additional provided properties.

    In all hooks except the onLog hook, the error will be augmented with code: "PLUGIN_ERROR" and plugin: plugin.name properties. If a code property already exists and the code does not start with PLUGIN_, it will be renamed to pluginCode.

    info: (log: string | RolldownLog | (() => string | RolldownLog)) => void

    Generate a "info" level log.

    code will be set to "PLUGIN_LOG" by Rolldown. As these logs are displayed by default, use them for information that is not a warning but makes sense to display to all users on every build.

    warn: (log: string | RolldownLog | (() => string | RolldownLog)) => void

    Generate a "warn" level log.

    Just like internally generated warnings, these logs will be first passed to and filtered by plugin onLog hooks before they are forwarded to custom onLog or onwarn handlers or printed to the console.

    We encourage you to use objects with a pluginCode property as that will allow users to easily filter for those logs in an onLog handler.