Adding support for getting keys of cache

aholstenson · Jun 15, 2017 · 2458695 · 2458695
1 parent 6916a70
commit 2458695
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 0 deletions.
diff --git a/cache/bounded.js b/cache/bounded.js
@@ -292,6 +292,11 @@ class BoundedCache {
 		}
 	}
 
+	keys() {
+		this[EVICT]();
+		return Array.from(this[DATA].values.keys());
+	}
+
 	[ON_REMOVE](key, value, cause) {
 		const data = this[DATA];
 		if(data.removalListener) {

diff --git a/cache/boundless.js b/cache/boundless.js
@@ -115,6 +115,11 @@ class BoundlessCache {
 		}
 	}
 
+	keys() {
+		this[EVICT]();
+		return Array.from(this[DATA].values.keys());
+	}
+
 	[ON_REMOVE](key, value, cause) {
 		const data = this[DATA];
 		if(data.removalListener) {

diff --git a/test/bounded.test.js b/test/bounded.test.js
@@ -65,6 +65,13 @@ describe('BoundedCache', function() {
 		expect(cache.size).to.equal(0);
 	});
 
+	it('Getting keys work', function() {
+		const cache = new BoundedCache({ maxSize: 50 });
+		cache.set('key', 'value');
+
+		expect(cache.keys()).to.deep.equal([ 'key' ]);
+	});
+
 	describe('Eviction', function() {
 		it('Does not exceed maxSize', function() {
 			const maxSize = 10;
@@ -96,6 +103,17 @@ describe('BoundedCache', function() {
 			expect(cache.get(2)).to.equal(2);
 			expect(cache.get(3)).to.equal(3);
 		});
+
+		it('Keys evicted before array returned', function() {
+			const maxSize = 10;
+			const cache = new BoundedCache({ maxSize });
+
+			for(let i=0; i<maxSize*2; i++) {
+				cache.set(i, i);
+			}
+
+			expect(cache.keys().length).to.equal(maxSize);
+		});
 	});
 
 	describe('Removal listeners', function() {

diff --git a/test/boundless.test.js b/test/boundless.test.js
@@ -44,6 +44,13 @@ describe('BoundlessCache', function() {
 		expect(cache.size).to.equal(0);
 	});
 
+	it('Getting keys work', function() {
+		const cache = new BoundlessCache({});
+		cache.set('key', 'value');
+
+		expect(cache.keys()).to.deep.equal([ 'key' ]);
+	});
+
 	describe('Removal listeners', function() {
 		it('Triggers on delete', function() {
 			const listener = removalListener();

diff --git a/test/expiration.test.js b/test/expiration.test.js
@@ -104,6 +104,16 @@ describe('ExpirationCache', function() {
 				cb();
 			}, 1080);
 		});
+
+		it('Keys evicted before array returned', function(cb) {
+			const cache = newCache();
+			cache.set('key', 'value', { maxAge: '50 ms' });
+
+			setTimeout(() => {
+				expect(cache.keys().length).to.equal(0);
+				cb();
+			}, 1080);
+		});
 	});
 
 	describe('With maxNoReadAge', function() {