Contentstack Persistance Plugin Typescript

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.

This repository contains the Persistence Plugin for the TypeScript Delivery SDK of Contentstack. This plugin enables caching support for your Delivery SDK implementation by allowing you to persist API responses locally.

Prerequisite

You need Node.js version 4.4.7 or later installed to use the Contentstack Persistance Plugin.

Setup and Installation

Install the plugin via npm:

npm i @contentstack/persistance-plugin

To import the plugin in your project, use the following command:

import * as Peristance from '@contentstack/persistance-plugin'

To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

import contentstack from '@contentstack/delivery-sdk'
import * as Persistance from '@contentstack/persistance-plugin'

const stack = contentstack.stack({ 
  apiKey: "apiKey", 
  deliveryToken: "deliveryToken", 
  environment: "environment"
  cacheOptions: {
    policy: Policy.CACHE_THEN_NETWORK,
    persistance: Persistance.PersistanceStore()
  } 
});

Helpful Links

• Contentstack Website
• Official Documentation
• Content Delivery API Docs

The MIT License (MIT)

Copyright © 2025 Contentstack. All Rights Reserved

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.