[]previous and next page

sitemapIndexXml

The index file of several sitemaps (generateSitemaps): one <sitemap> per file, laid out like sitemapXml.

The index file of several sitemaps (generateSitemaps): one <sitemap> per file, laid out like sitemapXml. The same limits apply: 50 000 files and 50 MiB.

Import#

ts
import { sitemapIndexXml } from "@shadow-js/dusk/server";

Signature#

ts
function sitemapIndexXml(
  entries: readonly SitemapIndexEntry[],
  options: {
    readonly base?: URL | undefined;
    /** Largest file in UTF-8 bytes. Default {@link MAX_SITEMAP_BYTES}. */
    readonly maxBytes?: number | undefined;
  } = {},
): string

Parameters#

Name Description
entries The sitemap files, with their absolute URLs.
options base: the origin relative URLs resolve against.

Returns#

The XML document.

Throws#

  • RangeError past the limits.