keyv 3.1.0 → 4.0.0

package/README.md

@@ -142,6 +142,9 @@ The following are third-party storage adapters compatible with Keyv:
 - [quick-lru](https://github.com/sindresorhus/quick-lru) - Simple "Least Recently Used" (LRU) cache
 - [keyv-file](https://github.com/zaaack/keyv-file) - File system storage adapter for Keyv
 - [keyv-dynamodb](https://www.npmjs.com/package/keyv-dynamodb) - DynamoDB storage adapter for Keyv
+- [keyv-firestore ](https://github.com/goto-bus-stop/keyv-firestore) – Firebase Cloud Firestore adapter for Keyv
+- [keyv-mssql](https://github.com/pmorgan3/keyv-mssql) - Microsoft Sql Server adapter for Keyv
+- [keyv-memcache](https://github.com/jaredwray/keyv-memcache) - Memcache storage adapter for Keyv
 
 ## Add Cache Support to your Module
 
@@ -253,23 +256,32 @@ Set a value.
 
 By default keys are persistent. You can set an expiry TTL in milliseconds.
 
-Returns `true`.
+Returns a promise which resolves to `true`.
 
-#### .get(key)
+#### .get(key, [options])
 
-Returns the value.
+Returns a promise which resolves to the retrieved value.
+
+##### options.raw
+
+Type: `Boolean`<br>
+Default: `false`
+
+If set to true the raw DB object Keyv stores internally will be returned instead of just the value.
+
+This contains the TTL timestamp.
 
 #### .delete(key)
 
 Deletes an entry.
 
-Returns `true` if the key existed, `false` if not.
+Returns a promise which resolves to `true` if the key existed, `false` if not.
 
 #### .clear()
 
 Delete all entries in the current namespace.
 
-Returns `undefined`.
+Returns a promise which is resolved when the entries have been cleared.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Simple key-value storage with support for multiple backends",
   "main": "src/index.js",
   "scripts": {
@@ -29,10 +29,10 @@
   },
   "homepage": "https://github.com/lukechilds/keyv",
   "dependencies": {
-    "json-buffer": "3.0.0"
+    "json-buffer": "3.0.1"
   },
   "devDependencies": {
-    "ava": "^0.25.0",
+    "ava": "^2.2.0",
     "coveralls": "^3.0.0",
     "eslint-config-xo-lukechilds": "^1.0.0",
     "@keyv/mongo": "*",
@@ -41,9 +41,9 @@
     "@keyv/redis": "*",
     "@keyv/sqlite": "*",
     "@keyv/test-suite": "*",
-    "nyc": "^11.0.3",
+    "nyc": "^14.1.1",
     "this": "^1.0.2",
     "timekeeper": "^2.0.0",
-    "xo": "^0.20.1"
+    "xo": "^0.24.0"
   }
 }

package/src/index.js

@@ -17,6 +17,7 @@ const loadStore = opts => {
 		const adapter = opts.adapter || /^[^:]*/.exec(opts.uri)[0];
 		return new (require(adapters[adapter]))(opts);
 	}
+
 	return new Map();
 };
 
@@ -49,21 +50,25 @@ class Keyv extends EventEmitter {
 		return `${this.opts.namespace}:${key}`;
 	}
 
-	get(key) {
+	get(key, opts) {
 		key = this._getKeyPrefix(key);
-		const store = this.opts.store;
+		const { store } = this.opts;
 		return Promise.resolve()
 			.then(() => store.get(key))
 			.then(data => {
-				data = (typeof data === 'string') ? this.opts.deserialize(data) : data;
+				return (typeof data === 'string') ? this.opts.deserialize(data) : data;
+			})
+			.then(data => {
 				if (data === undefined) {
 					return undefined;
 				}
+
 				if (typeof data.expires === 'number' && Date.now() > data.expires) {
 					this.delete(key);
 					return undefined;
 				}
-				return data.value;
+
+				return (opts && opts.raw) ? data : data.value;
 			});
 	}
 
@@ -72,29 +77,32 @@ class Keyv extends EventEmitter {
 		if (typeof ttl === 'undefined') {
 			ttl = this.opts.ttl;
 		}
+
 		if (ttl === 0) {
 			ttl = undefined;
 		}
-		const store = this.opts.store;
+
+		const { store } = this.opts;
 
 		return Promise.resolve()
 			.then(() => {
 				const expires = (typeof ttl === 'number') ? (Date.now() + ttl) : null;
 				value = { value, expires };
-				return store.set(key, this.opts.serialize(value), ttl);
+				return this.opts.serialize(value);
 			})
+			.then(value => store.set(key, value, ttl))
 			.then(() => true);
 	}
 
 	delete(key) {
 		key = this._getKeyPrefix(key);
-		const store = this.opts.store;
+		const { store } = this.opts;
 		return Promise.resolve()
 			.then(() => store.delete(key));
 	}
 
 	clear() {
-		const store = this.opts.store;
+		const { store } = this.opts;
 		return Promise.resolve()
 			.then(() => store.clear());
 	}