GithubHelp home page GithubHelp logo

next-revalidate-route's Introduction

next-reavalidate-route

Tired of writing Next.js revalidate endpoint every time? Use next-reavalidate-route! It generates a Next.js route handler that you can use to revalidate paths and tags through query parameters. Optional allows you to protect it with Authorization header.

Setup

  1. npm i next-revalidate-route
  2. Create a route app/revalidate/route.ts
  3. Create the handler
import { nextRevalidateRoute } from 'next-revalidate-route'

// Send GET request to /revalidate?tags=one,two&paths=/blog/[slug],/route

// Protect with Authorization header
export async function GET(req: NextRequest) {
  return nextRevalidateRoute(req, {
    auth: 'your_secret',
    trustLocalhost: true,
  })
}

// Protect with custom auth callback
export async function GET(req: NextRequest) {
  return nextRevalidateRoute(req, {
    auth: async () => !!(await authorize()), // must return boolean
    trustLocalhost: true,
  })
}

Examples

curl -H "Authorization: your_secret" https://example.com/revalidate?tags=one,two,three&paths=/about,/blog/[slug],/route
fetch('https://example.com/revalidate?tags=one,two,three&paths=/about,/blog/[slug],/route', {
  headers: {
    Authorization: 'your_secret',
  },
})

next-revalidate-route's People

Contributors

tobbbe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.