createIntegration() — astro Function Reference

Architecture documentation for the createIntegration() function in index.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem

Entity Profile

CoreAstro→ RoutingSystem→ createIntegration() — astro Function Reference

Dependency Diagram

graph TD
  5a836056_3e51_0210_6735_e2fc6cb8021a["createIntegration()"]
  67448bc5_4839_7327_19c6_8973552e15f0["index.ts"]
  5a836056_3e51_0210_6735_e2fc6cb8021a -->|defined in| 67448bc5_4839_7327_19c6_8973552e15f0
  style 5a836056_3e51_0210_6735_e2fc6cb8021a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

examples/integration/index.ts lines 3–23

export default function createIntegration(): AstroIntegration {
	// See the Integration API docs for full details
	// https://docs.astro.build/en/reference/integrations-reference/
	return {
		name: '@example/my-integration',
		hooks: {
			'astro:config:setup': () => {
				// See the @astrojs/react integration for an example
				// https://github.com/withastro/astro/blob/main/packages/integrations/react/src/index.ts
			},
			'astro:build:setup': () => {
				// See the @astrojs/react integration for an example
				// https://github.com/withastro/astro/blob/main/packages/integrations/react/src/index.ts
			},
			'astro:build:done': () => {
				// See the @astrojs/partytown integration for an example
				// https://github.com/withastro/astro/blob/main/packages/integrations/partytown/src/index.ts
			},
		},
	};
}