https://github.com/oslabs-beta/splache
A GraphQL caching solution utilizing the speed of Redis
https://github.com/oslabs-beta/splache
graphql javascript npm npm-package redis redis-cache typescript
Last synced: about 1 year ago
JSON representation
A GraphQL caching solution utilizing the speed of Redis
- Host: GitHub
- URL: https://github.com/oslabs-beta/splache
- Owner: oslabs-beta
- License: mit
- Created: 2023-02-03T20:38:13.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-08T15:10:37.000Z (about 3 years ago)
- Last Synced: 2025-04-30T19:06:37.491Z (about 1 year ago)
- Topics: graphql, javascript, npm, npm-package, redis, redis-cache, typescript
- Language: TypeScript
- Homepage: http://splachejs.com/
- Size: 78.1 KB
- Stars: 49
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Lightweight NPM package for GraphQL Caching with Redis
[](public/LICENSE)
Introducing Splache (/splæʃ/), an agile, user-friendly, and lightweight JavaScript library that efficiently caches GraphQL queries using the power of Redis. The Splache library is designed for improved performance and reduced load on your GraphQL server. Through leveraging the speed and scalability of Redis, Splache is able to provide an efficient and unique solution for caching GraphQL queries!
[Launch Page](www.splachejs.com) : Learn More about Splache & Demo our package via an interactive sandbox pre-installation
[Install our NPM Package](https://www.npmjs.com/package/splache)
[Documentation](https://medium.com/@zhangn356/exploring-caching-solutions-for-graphql-an-introduction-to-splache-4a497bdb597f)
## Get Started and Installation
Run ```npm install splache``` to install the package to import ```SplacheCacheWhole```, ```ResolverCache``` and ```SplacheCache```.
### Quick Start with Redis
If you are new to Redis, here is the [documentation](https://redis.io/docs/getting-started/) to install redis and start a redis instance locally.
### Import splache
```node
import splache from 'splache'
```
## Key Features
1. The Caching of Whole Queries
Simply provide SpacheCacheWhole your schema, redis host, redis port, and password (Only provide the password if your external redis instance is password protected. If not, omit the password. Additionally, omit host, port, and password arguments if connecting to local redis instance) and then direct your queries through the middleware as seen in the example below.
```node
import { SplacheCacheWhole }
const cache = new SplacheCacheWhole(schema, host, post, password);
app.use('/graphql', cache.wholeCache, (req, res) => {
res.send(res.locals.queryResponse)
})
```
2. The Caching of Resolvers
```node
import { ResolverCache } from 'Splache'
const cache = new ResolverCache(host, port, password)
```
Upon importing ResolverCache from our package, create a new instance of ResolverCache to access the ‘checkCache’ method. From there, simply wrap your resolver functions with our pre-built functionality.
Here is an example:
```node
planet : {
type: Planet,
args: {
id : {
description: 'id of the planet'
type: new GraphQLNonNull(GraphQLString)
}
},
resolve: ((parent, args, context, info) => cache.checkCache(parents, args, context, info, getPlanet))
}
```
3. The Caching of Normalized Query Strings & Breakdown of Complex Nested Queries
Create a new instance of SplacheCache, passing in your schema, host, port, and password (omit host, port, and password if just connecting to local redis instance). By passing your query through our GQLquery method, it’ll generalize and split your query string and check the cache for these individual split queries. This reduces redundancy in your cache if existing cached queries are nested into a complex nested query.
```node
import { SplacheCache } from 'splache'
const cache = newSplacheCache(schema, host, port, password);
app.use('/graphql', cacheGQLquery, (req, res) => {
res.send(res.locals.queryResponse)
})
```
## Currently Under Development
## Connect with the Team!
| Nicholas Cathcart | Nicolas Jackson | Jessica Wang | Nancy Zhang |
| :---: | :---: | :---: | :---: |
| [](https://github.com/nhcathcart) [](https://www.linkedin.com/in/nicholas-cathcart-4b3834267/)| [](https://github.com/NicJax) [](www.linkedin.com/in/NicJax) | [](https://github.com/jesswang-dev) [](https://www.linkedin.com/in/jessica-xuecen-wang) | [](https://github.com/zhangn356 ) [](https://www.linkedin.com/in/zhangn356) |
## Want to Contribute?
Splache is an open-source product that is open to input and contributions from the community. After trying out the product, feel free to raise issues or submit a PR request.