npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

graphql-norm-stale

v0.6.1

Published

Staleness tracking for normalized GraphQL responses

Downloads

520

Readme

graphql-norm-stale

npm version travis build Coverage Status code style: prettier MIT license

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

import { normalize, denormalize, merge } from "graphql-norm";
import { request } from "graphql-request";

// A plain JS object to hold the normalized responses
let 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 data
const response = request(query);

// Normalize the response
const normalizedResponse = normalize(query, {}, response);

// Merge the normalized response into the cache
cache = merge(cache, normalizedResponse);

// Later when we want to read a query from the cache
const cachedResponse = denormalize(query, {}, cache);

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.

isStale(staleMap: 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.

clearStale(normMap: 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.

applyPatches(normMap: 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