@netlify/build/lib/types/netlify_plugin.d.ts

Netlify build module

import type { PluginInputs } from './config/inputs.js';
import type { OnBuild, OnEnd, OnError, OnPostBuild, OnPreBuild, OnSuccess } from './netlify_event_handler.js';
export interface NetlifyPlugin<TInputs extends PluginInputs = PluginInputs> {
    /**
     * Runs before the build command is executed.
     */
    onPreBuild?: OnPreBuild<TInputs>;
    /**
     * runs directly after the build command is executed and before Functions? bundling and Edge Handlers bundling.
     */
    onBuild?: OnBuild<TInputs>;
    /**
     * runs after the build command completes; after onBuild? tasks, Functions? bundling, and Edge Handlers bundling are executed; and before the deploy stage. Can be used to prevent a build from being deployed.
     */
    onPostBuild?: OnPostBuild<TInputs>;
    /**
     * runs when an error occurs in the build or deploy stage, failing the build. Can’t be used to prevent a build from being deployed.
     */
    onError?: OnError<TInputs>;
    /**
     * runs when the deploy succeeds. Can’t be used to prevent a build from being deployed.
     */
    onSuccess?: OnSuccess<TInputs>;
    /**
     * runs after completion of the deploy stage, regardless of build error or success; is useful for resources cleanup. Can’t be used to prevent a build from being deployed.
     */
    onEnd?: OnEnd<TInputs>;
}