Cache System

interface QueryEntry<T> {
  queryId: string;
  queryKey: QueryKey;
  keyHash: string;
  data: T;
  status: CacheStatus;
  state: QueryRecordState;
  updatedAt: string;        // ISO-8601
  staleAt: string | null;
  expiresAt: string | null;
  version: number;
  dependencies: string[];
  meta: Record<string, unknown>;
  error: Error | null;
  createdAt: number;
  lastFetchedAt: number | undefined;
  observerCount: number;
  retryCount: number;
  fetchStatus: QueryRecordFetchStatus;
  gcEligible: boolean;
  persistent: boolean;
  prefetched: boolean;
  manual: boolean;
  lastAccessedAt: number;
  accessCount: number;
}

import { CacheEngine } from '@soulcache/core';
 
const cache = new CacheEngine();
 
// Set data
cache.set({
  queryKey: ['users'],
  data: users,
  state: 'success',
});
 
// Get data
const entry = cache.get(['users']);
 
// Delete data
cache.delete(['users']);
 
// Clear all
cache.clear();

const cache = new CacheEngine({
  staleTime: 5 * 60 * 1000, // 5 minutes
  gcTime: 30 * 60 * 1000, // 30 minutes
  maxSize: 50000,
});

const cache = new CacheEngine({
  gcTime: 5 * 60 * 1000, // 5 minutes
});
 
// Entry is cached
cache.set({ queryKey: ['temp'], data: value });
 
// After gcTime, entry is removed

// When users are invalidated, user detail is also invalidated
cache.set({
  queryKey: ['users'],
  data: users,
  dependencies: ['user-1-hash', 'user-2-hash'],
});

cache.set({
  queryKey: ['counter'],
  data: 1,
});
 
// Entries track versions internally
const entry = cache.get(['counter']);
console.log(entry.version);

const entry = cache.get(['users']);
console.log(entry.observerCount); // Number of active subscribers