npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xml-sitemap-url-scraper

v1.1.0

Published

Scrapes all urls from an xml sitemap, or an array of xml sitemaps, including nested xml sitemaps.

Downloads

132

Readme

xml-sitemap-url-scraper

Call the function with an array of one or more XML sitemap urls. All sitemap urls provided in this array must not be compressed. Compressed sitemaps are only supported when nested under <sitemapindex> tags.

Normal: https://www.example.com/sitemap.xml

Compressed: https://www.example.com/sitemap.xml.gz

Returns a promise that resolves with an array of all URLs from those sitemaps

Install

npm install --save xml-sitemap-url-scraper

Requirements

To be compatible with async in example

Demo

npm start

Example

const { sitemapUrlScraper } = require("xml-sitemap-url-scraper");

let sitemapUrls = [
    "https://www.example.com/sitemap.xml"
]

// Define how many compressed sitemaps we want to decompress and process at once (if any are found)
let concurrency = 5;

// Function's concurrency defaults to 1 if no param is provided
let urls = sitemapUrlScraper(sitemapUrls, concurrency);

urls.then(result => {
    console.log("Returned URLs: ", result);
})
.catch(err => {
    console.log(err);
})

Example Output

Returned URLs:  [ 'https://www.example.com/page_one',
  'https://www.example.com/page_two' ]

Nested Sitemaps in <sitemapindex> tags

Nested sitemaps will automatically be traversed, and their urls will be included in the final output array. This currently only supports 1 level of nesting.

Exmaple of nested sitemaps

<sitemapindex xmlns="https://www.example.com/schemas/sitemap/0.84">
    <sitemap>
        <loc>https://www.example.com/edu/sitemap.xml</loc>
    </sitemap>
    <sitemap>
        <loc>https://www.example.com/gmail/sitemap.xml</loc>
    </sitemap>
</sitemapindex>

Compressed Sitemaps

Child sitemaps that are nested inside <sitemapindex> tags will be decompressed, and their urls will be included in the final output array. Compressed sitemaps are processed concurrently according to the parameter provided in the function call. This can help avoid memory and CPU load issues when processing a large number of compressed sitemaps. This function may take a long time to execute if there is a significant number of compressed sitemaps being scraped.

Example of compressed sitemaps

<sitemapindex xmlns="https://www.example.com/schemas/sitemap/0.84">
    <sitemap>
        <loc>https://www.example.com/edu/sitemap.xml.gz</loc>
    </sitemap>
    <sitemap>
        <loc>https://www.example.com/gmail/sitemap.xml.gz</loc>
    </sitemap>
</sitemapindex>