Interface CustomCache

Use this interface to define your own custom cache class.

Custom caches just have to implement the clearCache, getUrl and setUrl methods. How you define those methods internally is up to you.

Example

import { Soccer, type CustomCache } from '@reuters-graphics/sportlich';

class MyCustomCache implements CustomCache {
  private cache: Record<string, { json: unknown, lastUpdated: string }> = {};

  clearCache() {
    this.cache = {};
  }

  getUrl(url: string, maxAge: number) {
    const cachedData = this.cache[url];
    if (!cachedData) return null;
    const { json, lastUpdated } = cachedData;
    const secondsSinceUpdate = (Date.now() - new Date(lastUpdated).getTime()) / 1000;
    if (secondsSinceUpdate <= maxAge ) return json;
    return null;
  }

  setUrl(url: string, json: unknown) {
    this.cache[url] = {
      lastUpdated: new Date().toISOString(),
      json,
    };
  }
}

// Pass your custom cache to new sportlich instance
const soccer = new Soccer({ cache: new MyCustomCache() });
Copy