sitemapper/sitemapper.d.ts

Parser for XML Sitemaps to be used with Robots.txt and web crawlers

export interface SitemapperResponse {
  url: string;
  sites: string[];
  errors: SitemapperErrorData[];
}

export interface SitemapperErrorData {
  type: string;
  url: string;
  retries: number;
}

export interface SitemapperOptions {
  concurrency?: number;
  debug?: boolean;
  lastmod?: number;
  rejectUnauthorized?: boolean;
  requestHeaders?: { [name: string]: string };
  retries?: number;
  timeout?: number;
  url?: string;
  fields?: { [name: string]: boolean };
  exclusions?: RegExp[];
}

declare class Sitemapper {
  timeout: number;

  constructor(options: SitemapperOptions);

  /**
   * Gets the sites from a sitemap.xml with a given URL
   *
   * @param url URL to the sitemap.xml file
   */
  fetch(url?: string): Promise<SitemapperResponse>;
}

export default Sitemapper;