Next.js self-hosting simplified.
npm install @neshca/cache-handler@neshca/cache-handlerFlexible API for replacing the default Next.js cache, enabling custom caching solutions for multi-instance self-hosted deployments.
š Version 1.9.0 has been released! It changes the default estimateExpireAge function to perform the calculation as (staleAge) => staleAge * 1.5 to better align with the default Next.js cache behavior.
This is the final release leading up to version 2.0.0. The upcoming version 2 will bring significant changes and will no longer support Next.js versions 13 and 14. While version 1 will still receive ongoing maintenance, it won't get any new features.
Check out the changelog for more details.
1. Overview
- Features
2. Getting Started
3. Examples
4. Requirements
5. Documentation
6. Contributing
7. License
Welcome to @neshca/cache-handler (pronounced /ĖnƦŹkŹ/), a specialized ISR/Data cache API crafted for Next.js applications. This library simplifies configuring shared cache strategies in distributed environments, such as multiple, independent application instances. It offers a flexible and easy-to-integrate solution for custom cache strategies, especially for Redis.
- Shared Cache for Distributed Environments: Perfect for self-hosted deployments with multiple application instances.
- Easy Customization: Provides a straightforward API with pre-configured Handlers.
- On-Demand Revalidation: Simplifies revalidation across all application replicas.
- TTL Management: Automatic cache cleanup to keep storage space efficient.
- Support for Next.js Routers: Full support and one setup for the Pages and the App Router.
- neshCache Function: Utilize the neshCache ā function to replace unstable_cache for more control over caching.
- neshClassicCache Function: Use the CacheHandler in the Pages Router to cache the result of expensive operations in the getServerSideProps and API routes.
- Pre-populate the Cache with Initial Data: Automatically pre-populate the cache with the initial data when the application starts using the instrumentation hook ā.
Enhance your application's caching with our Installation and First Steps Guide. This guide covers installation, basic configuration, and practical examples for quick integration.
Explore the versatility of @neshca/cache-handler in our Examples Section with real-world scenarios. Learn how to build a custom Handler by following this guide.
- Next.js: 13.5.1 or newer (below 15.0.0).
- Node.js: 18.17.0 or newer.
For detailed documentation, visit our Documentation Page.
We welcome contributions! Check out our Contributing Guide for more information.
This project is licensed under the MIT License.