0.2.1 • Published 3 years ago
@galaxis/in-memory-cache v0.2.1
Galaxis In-Memory Cache
A Galaxis cache that stores state in memory and is observable via Redux DevTools.
Installation
yarn add @galaxis/in-memory-cacheYou need to install Galaxis Core as well, directly or indirectly.
The library is compiled to modern JS, but it should work in all reasonable browsers with the help of properly configured Babel.
Public API
⚠ Anything that is not documented here is not considered a part of public API and may change at any time.
InMemoryCache
Implements Cache.
const inMemoryCache = new InMemoryCache({ emptyData, initialState, enableDevTools });Arguments
| Name | Type | Description | Required |
|---|---|---|---|
| emptyData | C | A value that conforms to C, that is considered to be empty. E.g. {entities: {}} | Yes |
| initialState | CacheState<C, ErrorObject > | A value from cache.extract(), most likely from SSR. | No |
| enableDevTools | boolean | Enable Redux DevTools integration. | No |
cache.extract()
Returns the cache state in serializable form. Uses serialize-error to convert errors into serializable objects.
const state = cache.extract();Return value
Important types
CacheState
Internal state of the cache.
| Name | Type | Description |
|---|---|---|
| data | C | Cache data. |
| errors | Record<string, E | undefined> | Cached errors. E is Error by default. |