graphql-norm-stale
Staleness tracking for normalized GraphQL responses
How to install
npm install graphql-norm-stale --save
Introduction
When caching several normalized graphql responses it is sometimes helpful to mark some entries in the cache as stale. This package helps with tracking of stale entries.
Example usage
;; // A plain JS object to hold the normalized responseslet cache = {}; const query = gql` query TestQuery { posts { id __typename title author { id __typename name } comments { id __typename commenter { id __typename name } } } }`; // Make a request to fetch the dataconst response = ; // Normalize the responseconst normalizedResponse = ; // Merge the normalized response into the cachecache = ; // Later when we want to read a query from the cacheconst cachedResponse = ;
API
isStale()
The isStale() function takes a map of stale fields and a map of fields and checks if the fields are among the stale entries. The stale field map contains another map of fields for each key. This secondary map can only have entries with value true. The reason a map is used instead of an array is to have faster checking of membership of fields.
isStalestaleMap: FieldsMap, fields: FieldsMap: boolean
clearStale()
The clearStale()
function takes a map of normalized GraphQL objects and a map of stale fields. It removes any fields in the staleness map that are present in the normalized map.
clearStalenormMap: NormMap, staleMap: FieldsMap: FieldsMap
invalidateEntity()
Creates a patch for invalidation of an entity.
invalidateField()
Creates a patch for invalidation of an entity's field.
applyPatches()
Returns a new map of stale fields with the patches applied. It needs the normMap
in order to do recursive patches.
applyPatchesnormMap: NormMap, staleMap: FieldsMap: FieldsMap
Related packages
How to develop
Node version >=12.6.0 is needed for development.
To execute the tests run yarn test
.
How to publish
yarn version --patch
yarn version --minor
yarn version --major