Installation

npm install --save @types/express-sitemap-xml

Summary

This package contains type definitions for express-sitemap-xml (https://github.com/feross/express-sitemap-xml).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-sitemap-xml.

index.d.ts

1import express = require("express");
2
3/**
4 * Create a sitemap.xml middleware.
5 * @param getUrls Is called at most once per 24 hours. The resulting sitemap(s)
6 *   are cached to make repeated HTTP requests faster.
7 * @param base Specifies the base URL to be used in case any URLs are specified
8 *   as relative URLs. The argument is also used if a sitemap index needs to be
9 *   generated and sitemap locations need to be specified, e.g.
10 *   `${base}/sitemap-0.xml` becomes `https://bitmidi.com/sitemap-0.xml`.
11 */
12declare function expressSitemapXml(
13    getUrls: () => expressSitemapXml.SitemapLeaf[] | Promise<expressSitemapXml.SitemapLeaf[]>,
14    base: string,
15): express.RequestHandler;
16
17declare namespace expressSitemapXml {
18    interface LeafObject {
19        changeFreq?: string | undefined;
20        /** specify `true` for today's date */
21        lastMod?: string | Date | true | undefined;
22        url: string;
23    }
24
25    type SitemapLeaf = string | LeafObject;
26
27    interface Sitemap {
28        [leaf: string]: string;
29    }
30
31    /**
32     * @async
33     * Create an object where the keys are sitemap URLs to be served by the
34     * server and the values are strings of sitemap XML content
35     */
36    function buildSitemaps(urls: SitemapLeaf[], base: string): Promise<Sitemap>;
37}
38
39export = expressSitemapXml;
40

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/express

Credits

These definitions were written by Florian Imdahl, and Piotr Błażejewicz.