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

gatsby-plugin-endpoints

v1.0.9

Published

Gatsby plugin that exposes all gatsby pages under /endpoints.json path

Downloads

439

Readme

📖 gatsby-plugin-endpoints npm License

Simple Gatsby plugin that exposes an endpoint that lists all the Gatsby's pages URLs.

Installation

  • Install gatsby-plugin-endpoints with npm/yarn/pnpm:

    npm i gatsby-plugin-endpoints --save-dev
  • Add it to the array of plugins in gatsby.config.js:

module.exports = {
  // ... Other settings
  plugins: [
    // ... Other plugins
    `gatsby-plugin-endpoints`,
  ]
}
  • Start the Gatsby's development server
gatsby develop
  • Navigate to URL
http://localhost:8000/endpoints.json
  • You'll get list of all pages and blog posts in JSON format e.g.
[
   "/blog/sample-article",
   "/blog/sample2-article/",
   "/page1/",
   "/page2/"
]

Configuration

Plugin allows to apply filter to the list of pages. For that it's required to pass a function as a configuration property for filter e.g.:

  • Simple filter usage - gatsby.config.js:
module.exports = {
  // ... Other settings
  plugins: [
    // ... Other plugins
    {
      resolve: `gatsby-plugin-endpoints`,
      options: {
        filter: ({ node: { path, pageContext } }) => !["dev-404-page", "/404.html"].includes(path), // Filter out pages ["dev-404-page", "/404.html"] from the list
    },
  ]
}
  • Advanced filter usage - gatsby.config.js:
module.exports = {
  // ... Other settings
  plugins: [
    // ... Other plugins
    {
      resolve: `gatsby-plugin-endpoints`,
      options: {
        // Second param passed to filter is 'req' object from express server -> https://expressjs.com/en/api.html#req
        filter: ({ node: { path, pageContext } }, { query: { maxAge } }) => {
          // Get query param from request -> http://localhost:8000/endpoints.json?maxAge=1
          if (maxAge) {
            // Filter pages based on the date passed in page context object during page creation https://www.gatsbyjs.com/docs/reference/config-files/actions/#createPage
            return pageContext?.date
                ? subtractDate(new Date(), { years: maxAge }) <
                  parseISO(pageContext.date, new Date())
                : true;
          }
          
          return true;
        }
      },
    },
  ]
}

License

Made with :sparkling_heart: by Bartlomiej Zuber ([email protected]) and licensed under the MIT License