graphile-cache 1.4.10 → 1.4.12

package/README.md

@@ -16,17 +16,17 @@
   </a>
 </p>
 
-PostGraphile instance LRU cache with automatic cleanup when PostgreSQL pools are disposed.
+**`graphile-cache`** is an LRU cache for PostGraphile handlers with automatic cleanup when PostgreSQL pools are disposed.
 
-## Installation
+> This package integrates with `pg-cache` for PostgreSQL pool management.
+
+## 🚀 Installation
 
 ```bash
 npm install graphile-cache pg-cache
 ```
 
-Note: This package depends on `pg-cache` for the PostgreSQL pool management.
-
-## Features
+## ✨ Features
 
 - LRU cache for PostGraphile instances
 - Automatic cleanup when associated PostgreSQL pools are disposed
@@ -34,26 +34,24 @@ Note: This package depends on `pg-cache` for the PostgreSQL pool management.
 - Service cache re-exported for convenience
 - TypeScript support
 
-## How It Works
+## 🧠 How It Works
 
 When you import this package, it automatically registers a cleanup callback with `pg-cache`. When a PostgreSQL pool is disposed, any PostGraphile instances using that pool are automatically removed from the cache.
 
-## Usage
+## 📦 Usage
 
-### Basic Usage
+### Basic caching flow
 
 ```typescript
 import { graphileCache, GraphileCache } from 'graphile-cache';
 import { getPgPool } from 'pg-cache';
 import { postgraphile } from 'postgraphile';
 
-// Create a PostGraphile instance
 const pgPool = getPgPool({ database: 'mydb' });
 const handler = postgraphile(pgPool, 'public', {
   // PostGraphile options
 });
 
-// Cache it
 const cacheEntry: GraphileCache = {
   pgPool,
   pgPoolKey: 'mydb',
@@ -69,7 +67,7 @@ if (cached) {
 }
 ```
 
-### Automatic Cleanup
+### Automatic cleanup
 
 The cleanup happens automatically:
 
@@ -89,7 +87,7 @@ console.log(graphileCache.has('mydb.public')); // false
 console.log(graphileCache.has('mydb.private')); // false
 ```
 
-### Complete Example
+### Complete example with Express
 
 ```typescript
 import { graphileCache, GraphileCache } from 'graphile-cache';
@@ -98,13 +96,13 @@ import { postgraphile } from 'postgraphile';
 
 function getGraphileInstance(database: string, schema: string): GraphileCache {
   const key = `${database}.${schema}`;
-  
+
   // Check cache first
   const cached = graphileCache.get(key);
   if (cached) {
     return cached;
   }
-  
+
   // Create new instance
   const pgPool = getPgPool({ database });
   const handler = postgraphile(pgPool, schema, {
@@ -112,13 +110,13 @@ function getGraphileInstance(database: string, schema: string): GraphileCache {
     graphiqlRoute: '/graphiql',
     // other options...
   });
-  
+
   const entry: GraphileCache = {
     pgPool,
     pgPoolKey: database,
     handler
   };
-  
+
   // Cache it
   graphileCache.set(key, entry);
   return entry;
@@ -136,14 +134,14 @@ app.use((req, res, next) => {
 ```typescript
 import { closeAllCaches } from 'graphile-cache';
 
-// This closes all caches including pg pools
 process.on('SIGTERM', async () => {
+  // Closes all caches including pg pools
   await closeAllCaches();
   process.exit(0);
 });
 ```
 
-## API Reference
+## 📘 API Reference
 
 ### graphileCache
 
@@ -173,7 +171,7 @@ Closes all caches including the service cache, graphile cache, and all PostgreSQ
 
 Re-exported from `pg-cache` for convenience.
 
-## Integration Details
+## 🔌 Integration Details
 
 The integration with `pg-cache` happens automatically when this module is imported. The cleanup callback is registered immediately, ensuring that PostGraphile instances are cleaned up whenever their associated PostgreSQL pools are disposed.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-cache",
-  "version": "1.4.10",
+  "version": "1.4.12",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "PostGraphile LRU cache with automatic pool cleanup integration",
   "main": "index.js",
@@ -49,5 +49,5 @@
     "postgresql",
     "launchql"
   ],
-  "gitHead": "4e1ff9771c2b07808a9830281abc24d12c689187"
+  "gitHead": "ea3f6b8d86ba521ee629411efb4cf4133cc6e302"
 }