Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fusioncharts/redis-contentful
A tiny library to map Contentful ☁️ space into Redis ⚡️
https://github.com/fusioncharts/redis-contentful
cache cms contentful redis
Last synced: about 1 month ago
JSON representation
A tiny library to map Contentful ☁️ space into Redis ⚡️
- Host: GitHub
- URL: https://github.com/fusioncharts/redis-contentful
- Owner: fusioncharts
- License: mit
- Created: 2018-03-17T05:03:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T14:34:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T09:07:45.130Z (about 1 month ago)
- Topics: cache, cms, contentful, redis
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/redis-contentful
- Size: 193 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redis Contentful [](https://www.npmjs.com/package/redis-contentful) [](https://github.com/fusioncharts/redis-contentful/blob/master/LICENSE)
A tiny library to map Contentful ☁️ space into Redis ⚡️
## Why should I care?
Say your marketing team loves to update content without you being involved? Great! That is why you should use Contentful CMS. But wait, there is a catch. Contentful API sometimes takes `~800ms`. And this is really a hit when you're having fancy SSR implemented to boost the performance of your Node JS app. As the creator of Gmail, Paul Buchheit had said "Every interaction should be faster than `100ms`. Why? Because `100ms` is the threshold where interactions feel instantaneous".
This is where redis will help you crunch the rendering speed. It's really, really fast! A few `ms` is all it needs to get your data. By few, I mean less than `100ms` 🚀
`redis-contentful` maps your Contentful space's content types and their published records into your Redis server. It also maintains the schema of your Contentful space. All content types are stored in Redis as hashes. Under a particular hash, the record is stored as a key value pair with id being the record's key.
You can `sync` the data manually by calling the sync method on `redis-contentful` instance manually or you can add a webhook in Contentful by exposing an endpoint on your server which will internally call `sync`. In this way, you always have the latest content from Contentful right in your Redis.
So let's get started!
## Installation
```sh
npm install redis-contentful --save
```
## Usage
Create an instance of `redis-contentful` by passing contentful space ID & access token.
```js
import RedisContentful from 'redis-contentful';
const client = new RedisContentful({
redis: {
database: 0, // Optional param, default - 0
host: '', // Optional param, default - 127.0.0.1
port: '', // Optional param, default - 6379
},
contentful: {
space: '',
accessToken: '',
locale: '', // Optional param, default - en-US
identifier: '', // Identifier for searching custom keys,
environment: '', // contentful environment, default is master
},
});
```
## API
### sync
Syncs the latest space content from Contentful and dumps it in your Redis server 🎉
```js
await client.sync();
```
Send an optional boolean param to `sync` if you want to reset your redis cache ♻️
```js
await client.sync(true);
```
### get - _directly from Redis 🚀_
Gets all data
```js
await client.get();
```
Pass specific content type. It's an optional parameter.
```js
await client.get('about');
```
Pass an array specifying the required content types
```js
await client.get(['about', 'title']);
```
Pass an object to narrow down search
```js
await client.get({
// Content type, it can also be an array
type: '',
// This will search identifier key for specified value
search: '',
});
```
You'll get an object with your content type ID's as keys and their values as array of content objects.
If you specify a specific key, only that key will be returned in the final object.
```js
{
"": [{}, {}, {}],
"": [{}, {}]
}
```
### Custom keys in Redis
Set, get & delete your custom key - value pairs in Redis
```js
await client.setCustom('avengers', '🤯');
/* can set expire time in seconds. Third parameter is optional */
await client.setCustom('Hulk', "I'm Hulk!", 60);
await client.getCustom('avengers'); // 🤯
await client.deleteCustom('avengers');
```
### Changing Redis DB
```js
// Sets DB to specified value, default is 0
await client.setDB();
```
### close
Closes the connection to redis client.
```js
await client.close();
```
## Redis Store
> In Redis, the keys (entries) will be prefixed with their respective content type 🤓
## License
MIT ❤