Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanhefner/creature-cache
🧟♂️ An in-memory cache that can be restored/rehydrated (brought back to life) via a string or array to rebuild the cache Map.
https://github.com/ryanhefner/creature-cache
cache javascript map next-contentful next-request-block react-contentful react-request-block rehydrate resurrect server-side-rendering
Last synced: 2 days ago
JSON representation
🧟♂️ An in-memory cache that can be restored/rehydrated (brought back to life) via a string or array to rebuild the cache Map.
- Host: GitHub
- URL: https://github.com/ryanhefner/creature-cache
- Owner: ryanhefner
- License: mit
- Created: 2019-08-15T18:11:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-04T07:36:32.000Z (over 3 years ago)
- Last Synced: 2024-08-10T09:59:42.318Z (about 2 months ago)
- Topics: cache, javascript, map, next-contentful, next-request-block, react-contentful, react-request-block, rehydrate, resurrect, server-side-rendering
- Language: JavaScript
- Homepage: https://www.pkgstats.com/pkg:creature-cache
- Size: 562 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🧟♂️ creature-cache
[](https://www.pkgstats.com/pkg:creature-cache)
[](https://www.pkgstats.com/pkg:creature-cache)
[](https://www.pkgstats.com/pkg:creature-cache)
[](https://coveralls.io/github/ryanhefner/creature-cache)
An in-memory cache that can be restored/rehydrated (brought back to life) via a string or array to rebuild
the cache Map.
This is particularly handy for frameworks that can generate a cache
server-side, and would want to reflect that same cache client-side. For example,
anything built in [Next](https://nextjs.com) or [React](https://reactjs.org) that
is rendered server-side.
I realized I was using the same/similar cache instance in [`react-contentful`](https://github.com/ryanhefner/creature-cache),
[`react-request-block`](https://github.com/ryanhefner/react-request-block), and
a new package that I am currently writing, so it just made sense to make this its
own package.
## Install
Via [npm](https://npmjs.com/package/creature-cache)
```sh
npm install --save creature-cache
```
Via [Yarn](https://yarn.fyi/creature-cache)
```sh
yarn add creature-cache
```
## How to use
There really isn’t anything too magical about this package. Just a `Map` instance
with a bit of an interface around it to handle initializing, accessing and extracting
the current cached values.
### Initialization
Intializing a new `creature-cache` instance is pretty straight forward. Just create
your new instance, and optionally include a `cache` value to rehydrate the cache with.
The `cache` can be an `Array`, `Object`, or a `string` that can converted back into
an object. Internally, this package uses [`flatted`](https://github.com/WebReflection/flatted)
to parse the string and build the internal `Map` instance.
```js
import Cache from 'creature-cache';
const cache = new Cache();
... [go nuts]
```
### Methods
* `clear(): Cache` - Clear the internal cache `Map` and return a reference back to `Cache` instance so methods can be chained.
* `extract(): Array` - Extract the internal cache `Map` as an array.
* `has(key): boolean` - Check to see if the cache has an instance for the `key` provided.
* `read(key): any` - Read the cached value associated to the provided `key`.
* `restore(cache): Cache` - In the event you want to restore a cache after an instance has been initialized, call this.
* `write(key, value): Cache` - Write a cache value to the associated key.
## License
[MIT](LICENSE) © [Ryan Hefner](https://www.ryanhefner.com)