JavaScript-Bibliothek common-cache

Diese Bibliothek bietet Funktionen zum Bearbeiten von Werten im Cache und stellt sicher, dass Anwendungen effizient mit zwischengespeicherten Daten arbeiten können.

Verwendung

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let cache = require('common/cache')('cache-name', max-items, max-life-time);

Konstruktoren

Konstruktor	Beschreibung	Standard
cache-name	Definiert den eindeutingen Namen des systemweiten Caches, in den das System Werte ablegt.	–
max-items	Definiert optional die maximale Anzahl an Einträgen im Cache. Sobald die Anzahl überschritten wird, entfernt das System die ältesten Einträge automatisch. Lesezugriffe aktualisieren den Zeitstempel, sodass häufig verwendete Einträge automatisch im Cache bleiben.	2³¹-1 (der Maximalwert von Integer)
max-life-time	Definiert optional die maximale Dauer in Millisekunden, wie lange ein Eintrag im Cache verbleibt, bevor das System ihn automatisch entfernt. Lesezugriffe verlängern die Lebensdauer, sodass häufig verwendete Einträge automatisch im Cache bleiben.	2³¹-1 (der Maximalwert von Integer)

Funktionen

read

Liest einen Wert aus dem Cache, basierend auf einem Schlüssel (beliebiger String). Gibt den Wert zurück oder null, wenn der Schlüssel nicht vorhanden ist.

cache.read('key')

Beispiel:

let cache = require('common/cache')('example-cache');

// Write an entry to the cache with key 'greeting'
cache.write('greeting', 'Hello, World!');

// Read the value of the key 'greeting' from the cache
let value = cache.read('greeting');
console.log(value);

write

Schreibt einen Wert in den Cache, basierend auf einem Schlüssel (beliebiger String).

Der Wert kann ein beliebiges Objekt sein.
Das System ersetzt einen vorhandenen Eintrag mit demselben Schlüssel.

cache.write('key', value)

Beispiel:

let cache = require('common/cache')('example-cache');

// Write an entry to the cache with key 'count'
cache.write('count', 42);

// Check the storedValue by logging to console
let storedValue = cache.read('count');
console.log(storedValue);

delete

Löscht einen Eintrag aus dem Cache, basierend auf dem angegebenen Schlüssel.

cache.delete('key')

Beispiel:

let cache = require('common/cache')('example-cache');

// Write an entry to the cache with key 'temp'
cache.write('temp', 'Temporary Value');

// Delete the value from the cache
cache.delete('temp');

// Try to read the value to check that it is gone
let value = cache.read('temp');
console.log(value); // Output: null (entry no longer exists)

forEach

Durchläuft alle Einträge im Cache und führt für jeden Eintrag eine angegebene Funktion aus.

Parameter: Eine Callback-Funktion, die für jeden Cache-Eintrag aufgerufen wird. Diese Funktion erhält den Wert und den Schlüssel des Eintrags als Argumente.

cache.forEach((value, key) => {
  // callback
});

Beispiel:

let cache = require('common/cache')('example-cache');

// Write multiple values to the cache
cache.write('name', 'Alice');
cache.write('age', 30);
cache.write('city', 'Wonderland');

let cacheContents = {};

// Iterate over all entries in the cache
cache.forEach((value, key) => {
  cacheContents[key] = value;
});

// Output the cache content
console.log(cacheContents);

synchronize

Erlaubt es, mehrere Aktionen auf einer Cache-Instanz atomar durchzuführen, um die Datenintegrität zu gewährleisten.

Parameter: Eine Funktion, die die synchronisierten Operationen ausführt.

cache.synchronize(() => {
  // critical operation
});

Beispiel:

let cache = require('common/cache')('example-cache');

// Simulate a situation requiring synchronization
cache.synchronize(() => {
  let currentValue = cache.read('counter') || 0;
  cache.write('counter', currentValue + 1);
});

// Check whether the counter was updated
let counterValue = cache.read('counter');
console.log(counterValue);