SitemapOptions Type — astro Architecture

Source Code

packages/integrations/sitemap/src/index.ts lines 21–55

export type SitemapOptions =
	| {
			filenameBase?: string;
			filter?(page: string): boolean;
			customSitemaps?: string[];
			customPages?: string[];

			i18n?: {
				defaultLocale: string;
				locales: Record<string, string>;
			};
			// number of entries per sitemap file
			entryLimit?: number;
			// sitemap specific
			changefreq?: ChangeFreq;
			lastmod?: Date;
			priority?: number;

			// called for each sitemap item just before to save them on disk, sync or async
			serialize?(item: SitemapItem): SitemapItem | Promise<SitemapItem | undefined> | undefined;

			xslURL?: string;
			chunks?: Record<
				string,
				(item: SitemapItem) => SitemapItem | Promise<SitemapItem | undefined> | undefined
			>;
			// namespace configuration
			namespaces?: {
				news?: boolean;
				xhtml?: boolean;
				image?: boolean;
				video?: boolean;
			};
	  }
	| undefined;