Interface AstroIntegration

Type declaration

• Optional astro:build:done?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            cacheManifest: boolean;
            dir: URL;
            logger: AstroIntegrationLogger;
            pages: {
                pathname: string;
            }[];
            routes: RouteData[];
        }

        • cacheManifest: boolean

        • dir: URL

        • logger: AstroIntegrationLogger

        • pages: {
              pathname: string;
          }[]

        • routes: RouteData[]

      Returns void | Promise<void>

• Optional astro:build:generated?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            dir: URL;
            logger: AstroIntegrationLogger;
        }

        • dir: URL

        • logger: AstroIntegrationLogger

      Returns void | Promise<void>

• Optional astro:build:setup?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            logger: AstroIntegrationLogger;
            pages: Map<string, PageBuildData>;
            target: "server" | "client";
            updateConfig: ((newConfig) => void);
            vite: InlineConfig;
        }

        • logger: AstroIntegrationLogger

        • pages: Map<string, PageBuildData>

        • target: "server" | "client"

        • updateConfig: ((newConfig) => void)

          • • (newConfig): void

            • Parameters

              • newConfig: InlineConfig

              Returns void

        • vite: InlineConfig

      Returns void | Promise<void>

• Optional astro:build:ssr?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            entryPoints: Map<RouteData, URL>;
            logger: AstroIntegrationLogger;
            manifest: SerializedSSRManifest;
            middlewareEntryPoint: undefined | URL;
        }

        • entryPoints: Map<RouteData, URL>

          This maps a RouteData to an URL, this URL represents the physical file you should import.

        • logger: AstroIntegrationLogger

        • manifest: SerializedSSRManifest

        • middlewareEntryPoint: undefined | URL

          File path of the emitted middleware

      Returns void | Promise<void>

• Optional astro:build:start?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            logger: AstroIntegrationLogger;
        }

        • logger: AstroIntegrationLogger

      Returns void | Promise<void>

• Optional astro:config:done?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            config: AstroConfig;
            logger: AstroIntegrationLogger;
            setAdapter: ((adapter) => void);
        }

        • config: AstroConfig

        • logger: AstroIntegrationLogger

        • setAdapter: ((adapter) => void)

          • • (adapter): void

            • Parameters

              • adapter: AstroAdapter

              Returns void

      Returns void | Promise<void>

• Optional astro:config:setup?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            addClientDirective: ((directive) => void);
            addDevOverlayPlugin: ((entrypoint) => void);
            addDevToolbarApp: ((entrypoint) => void);
            addMiddleware: ((mid) => void);
            addRenderer: ((renderer) => void);
            addWatchFile: ((path) => void);
            command: "build" | "preview" | "dev";
            config: AstroConfig;
            injectRoute: ((injectRoute) => void);
            injectScript: ((stage, content) => void);
            isRestart: boolean;
            logger: AstroIntegrationLogger;
            updateConfig: ((newConfig) => AstroConfig);
        }

        • addClientDirective: ((directive) => void)

          • • (directive): void

            • Parameters

              • directive: ClientDirectiveConfig

              Returns void

        • addDevOverlayPlugin: ((entrypoint) => void)

          Deprecated

          Use addDevToolbarApp instead. TODO: Fully remove in Astro 5.0

          • • (entrypoint): void

            • Parameters

              • entrypoint: string

              Returns void

        • addDevToolbarApp: ((entrypoint) => void)

          • • (entrypoint): void

            • Parameters

              • entrypoint: string | DevToolbarAppEntry

              Returns void

        • addMiddleware: ((mid) => void)

          • • (mid): void

            • Parameters

              • mid: AstroIntegrationMiddleware

              Returns void

        • addRenderer: ((renderer) => void)

          • • (renderer): void

            • Parameters

              • renderer: AstroRenderer

              Returns void

        • addWatchFile: ((path) => void)

          • • (path): void

            • Parameters

              • path: string | URL

              Returns void

        • command: "build" | "preview" | "dev"

        • config: AstroConfig

        • injectRoute: ((injectRoute) => void)

          • • (injectRoute): void

            • Parameters

              • injectRoute: InjectedRoute

              Returns void

        • injectScript: ((stage, content) => void)

          • • (stage, content): void

            • Parameters

              • stage: InjectedScriptStage
              • content: string

              Returns void

        • isRestart: boolean

        • logger: AstroIntegrationLogger

        • updateConfig: ((newConfig) => AstroConfig)

          • • (newConfig): AstroConfig

            • Parameters

              • newConfig: DeepPartial<AstroConfig>

              Returns AstroConfig

      Returns void | Promise<void>

• Optional astro:server:done?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            logger: AstroIntegrationLogger;
        }

        • logger: AstroIntegrationLogger

      Returns void | Promise<void>

• Optional astro:server:setup?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            logger: AstroIntegrationLogger;
            server: ViteDevServer;
            toolbar: {
                on: (<T_1>(event, callback) => void);
                onAppInitialized: ((appId, callback) => void);
                onAppToggled: ((appId, callback) => void);
                send: (<T>(event, payload) => void);
            };
        }

        • logger: AstroIntegrationLogger

        • server: ViteDevServer

        • toolbar: {
              on: (<T_1>(event, callback) => void);
              onAppInitialized: ((appId, callback) => void);
              onAppToggled: ((appId, callback) => void);
              send: (<T>(event, payload) => void);
          }

          • on: (<T_1>(event, callback) => void)

            Receive a message from a dev toolbar app.

            • • <T_1>(event, callback): void

              • Type Parameters

                • T_1

                Parameters

                • event: string
                • callback: ((data) => void)
                  • • (data): void

                    • Parameters

                      • data: T_1

                      Returns void

                Returns void

          • onAppInitialized: ((appId, callback) => void)

            Fired when an app is initialized.

            • • (appId, callback): void

              • Parameters

                • appId: string

                  The id of the app that was initialized
                • callback: ((data) => void)

                  The callback to run when the app is initialized

                  • • (data): void

                    • Parameters

                      • data: Record<string, never>

                      Returns void

                Returns void

          • onAppToggled: ((appId, callback) => void)

            Fired when an app is toggled on or off.

            • • (appId, callback): void

              • Parameters

                • appId: string

                  The id of the app that was toggled
                • callback: ((data) => void)

                  The callback to run when the app is toggled

                  • • (data): void

                    • Parameters

                      • data: {
                            state: boolean;
                        }

                        • state: boolean

                      Returns void

                Returns void

          • send: (<T>(event, payload) => void)

            Send a message to the dev toolbar that an app can listen for. The payload can be any serializable data.

            • • <T>(event, payload): void

              • Type Parameters

                • T

                Parameters

                • event: string

                  The event name
                • payload: T

                  The payload to send

                Returns void

      Returns void | Promise<void>

• Optional astro:server:start?: ((options) => void | Promise<void>)

  • • (options): void | Promise<void>

    • Parameters

      • options: {
            address: AddressInfo;
            logger: AstroIntegrationLogger;
        }

        • address: AddressInfo

        • logger: AstroIntegrationLogger

      Returns void | Promise<void>