fiftyone.pipeline.engines/lruCache.js

Shared base functionality for implementing engines for the 51Degrees Pipeline API

/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2025 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

const DataKeyedCache = require('./dataKeyedCache');
const LRU = require('./lru');

/**
 * An instance of DataKeyed cache using a least recently used (LRU) method
 **/
class LRUcache extends DataKeyedCache {
  /**
   * Constructor for LRUcache
   *
   * @param {object} options options for the lru cache
   * @param {number} options.size maximum entries in the cache
   */
  constructor ({ size = 100 }) {
    super(...arguments);

    this.cache = new LRU(size);
  }

  get (cacheKey) {
    return this.cache.read(cacheKey);
  }

  put (cacheKey, value) {
    this.cache.write(cacheKey, value);
  }
}

module.exports = LRUcache;