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 🙏

© 2024 – Pkg Stats / Ryan Hefner

loql-cache

v1.0.3

Published

A light, modular npm package for performant client-side GraphQL caching with Service Workers and IndexedDB. More detailed information about installing and configuring loQL can be found <a href="https://loql.land/docs">here</a>.

Downloads

2

Readme

loQL

A light, modular npm package for performant client-side GraphQL caching with Service Workers and IndexedDB. More detailed information about installing and configuring loQL can be found here.

Installation

Install via npm

npm install loql

Or with Yarn

yarn add loql

The service worker must also be included in your build folder. With webpack:

const path = require('path');

module.exports = {
  entry: {
    bundle: './client/index.js',
    loQL: './node_modules/loql-cache/loQL.js', // Add this line!
  },
  output: {
  path: path.resolve(__dirname, 'public'),
    filename: '[name].js',
    clean: true,
  },
  devServer: {
    static: './client',
  },
};

Register the service worker

import { register } from "loql-cache";
register({ gqlEndpoints: ["https://foo.com"] });

Settings

gqlEndpoints: string[] Required

Enable caching for specific GraphQL endpoint URLs. Network calls from the browser to any URL not listed here will be ignored by the service worker and the response data will not be cached.

useMetrics: boolean Optional

Enable metrics collection.

cacheMethod: string Optional

Desired caching strategy. The loql-cache package supports both "cache-first" and "cache-network" policies.

cacheExpirationLimit: Integer Optional

The interval, in milliseconds, after which cached data is considered stale.

doNotCacheGlobal: string[] Optional

Fields on a GraphQL query that will prevent the query from being cached, no matter the endpoint.

doNotCacheCustom:{ [url]: string[] } Optional

This setting is like doNotCacheGlobal, but can be used on a per-endpoint basis.

Example Configuration

const loQLConfiguration = {
  gqlEndpoints: ['http://localhost:<###>/api/graphql', 'https://<abc>.com/graphql'],
  useMetrics: false,
  cacheExpirationLimit: 20000,
  cacheMethod: 'cache-network',
  doNotCacheGlobal: [],
  doNotCacheCustom: {
     'http://localhost:<###>/api/graphql': ['password'],
     'https://<abc>.com/graphql': ['account', 'real_time_data'];
  }
};

register(loqlConfiguration);

Features

  • Enables offline use: IndexedDB storage provides high-capacity and persistent storage, while keeping reads/writes asynchronous
  • Minimum-dependency: No server-side component, avoid the use of large libraries
  • Cache validation: Keep data fresh with shorter expiration limits, cache-network strategy, or both!
  • Easy-to-use: Install package, register and configure service worker, start caching
  • Flexible: Works with GQL queries made as both fetch POST and GET requests
  • Easily exempt types of queries from being cached at the global or endpoint-specific level

Usage Notes

  • Caching is currently only supported for query-type operations. Mutations, subscriptions, etc will still run, but will not be cached.
  • Cached data normalization feature is disabled.

Contributing

Contributions are welcome. Please read CONTRIBUTE.md prior to making a Pull Request.

License

MIT