@se-studio/contentful-rest-api 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -2
- package/dist/index.d.ts +211 -186
- package/dist/index.js +212 -343
- package/dist/index.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -2,6 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
Type-safe Contentful REST API client with caching, rate limiting, and extensible converters for Next.js applications.
|
|
4
4
|
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Features](#features)
|
|
8
|
+
- [Installation](#installation)
|
|
9
|
+
- [Quick Start](#quick-start)
|
|
10
|
+
- [Basic Usage](#basic-usage)
|
|
11
|
+
- [Preview Mode](#preview-mode)
|
|
12
|
+
- [API Reference](#api-reference)
|
|
13
|
+
- [Client Functions](#client-functions)
|
|
14
|
+
- [Content Fetching Functions](#content-fetching-functions)
|
|
15
|
+
- [Converter Pattern](#converter-pattern)
|
|
16
|
+
- [Base Converter](#base-converter)
|
|
17
|
+
- [Enhancers](#enhancers)
|
|
18
|
+
- [Custom Converters](#custom-converters)
|
|
19
|
+
- [Caching](#caching)
|
|
20
|
+
- [Cache Tags](#cache-tags)
|
|
21
|
+
- [Cache Revalidation](#cache-revalidation)
|
|
22
|
+
- [Error Handling](#error-handling)
|
|
23
|
+
- [Retry Configuration](#retry-configuration)
|
|
24
|
+
- [Rate Limiting](#rate-limiting)
|
|
25
|
+
- [Type Generation](#type-generation)
|
|
26
|
+
- [Configuration Options](#configuration-options)
|
|
27
|
+
- [ContentfulConfig](#contentfulconfig)
|
|
28
|
+
- [FetchOptions](#fetchoptions)
|
|
29
|
+
- [CacheConfig](#cacheconfig)
|
|
30
|
+
- [RetryConfig](#retryconfig)
|
|
31
|
+
- [Next.js App Router Integration](#nextjs-app-router-integration)
|
|
32
|
+
- [License](#license)
|
|
33
|
+
- [Repository](#repository)
|
|
34
|
+
|
|
5
35
|
## Features
|
|
6
36
|
|
|
7
37
|
- 🎯 **Type-safe** - Full TypeScript support with generated types from your Contentful space
|
|
@@ -56,8 +86,10 @@ const page = await contentfulPageRest(
|
|
|
56
86
|
},
|
|
57
87
|
'home',
|
|
58
88
|
{
|
|
59
|
-
preview: true, // Uses Preview API
|
|
60
|
-
cache: {
|
|
89
|
+
preview: true, // Uses Preview API (CPA)
|
|
90
|
+
cache: {
|
|
91
|
+
cache: 'no-store' // Disable Next.js caching for preview content
|
|
92
|
+
}
|
|
61
93
|
}
|
|
62
94
|
);
|
|
63
95
|
```
|