keyv 4.0.2 → 4.1.0

package/.nyc_output/17c338d1-cd21-4d2f-9d97-398f18a945cf.json

@@ -0,0 +1 @@
+{}

package/.nyc_output/67b1f344-0eec-41a3-a665-c824c346e898.json

@@ -0,0 +1 @@
+{}

package/.nyc_output/adb04494-7d0a-443f-9130-94b19c3fa19c.json

@@ -0,0 +1 @@
+{"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/src/index.js":{"path":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/src/index.js","statementMap":{"0":{"start":{"line":3,"column":21},"end":{"line":3,"column":38}},"1":{"start":{"line":4,"column":14},"end":{"line":4,"column":36}},"2":{"start":{"line":7,"column":0},"end":{"line":9,"column":2}},"3":{"start":{"line":8,"column":1},"end":{"line":8,"column":24}},"4":{"start":{"line":11,"column":18},"end":{"line":28,"column":1}},"5":{"start":{"line":12,"column":18},"end":{"line":21,"column":2}},"6":{"start":{"line":22,"column":1},"end":{"line":25,"column":2}},"7":{"start":{"line":23,"column":18},"end":{"line":23,"column":66}},"8":{"start":{"line":24,"column":2},"end":{"line":24,"column":51}},"9":{"start":{"line":27,"column":1},"end":{"line":27,"column":18}},"10":{"start":{"line":32,"column":2},"end":{"line":32,"column":10}},"11":{"start":{"line":33,"column":2},"end":{"line":41,"column":4}},"12":{"start":{"line":43,"column":2},"end":{"line":46,"column":3}},"13":{"start":{"line":44,"column":26},"end":{"line":44,"column":54}},"14":{"start":{"line":45,"column":3},"end":{"line":45,"column":47}},"15":{"start":{"line":48,"column":2},"end":{"line":50,"column":3}},"16":{"start":{"line":49,"column":3},"end":{"line":49,"column":67}},"17":{"start":{"line":49,"column":40},"end":{"line":49,"column":65}},"18":{"start":{"line":52,"column":2},"end":{"line":52,"column":50}},"19":{"start":{"line":56,"column":2},"end":{"line":56,"column":41}},"20":{"start":{"line":60,"column":22},"end":{"line":60,"column":45}},"21":{"start":{"line":61,"column":20},"end":{"line":61,"column":29}},"22":{"start":{"line":62,"column":2},"end":{"line":76,"column":6}},"23":{"start":{"line":63,"column":15},"end":{"line":63,"column":37}},"24":{"start":{"line":64,"column":17},"end":{"line":64,"column":80}},"25":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"26":{"start":{"line":67,"column":5},"end":{"line":67,"column":22}},"27":{"start":{"line":70,"column":4},"end":{"line":73,"column":5}},"28":{"start":{"line":71,"column":5},"end":{"line":71,"column":22}},"29":{"start":{"line":72,"column":5},"end":{"line":72,"column":22}},"30":{"start":{"line":75,"column":4},"end":{"line":75,"column":56}},"31":{"start":{"line":80,"column":22},"end":{"line":80,"column":45}},"32":{"start":{"line":81,"column":2},"end":{"line":83,"column":3}},"33":{"start":{"line":82,"column":3},"end":{"line":82,"column":23}},"34":{"start":{"line":85,"column":2},"end":{"line":87,"column":3}},"35":{"start":{"line":86,"column":3},"end":{"line":86,"column":19}},"36":{"start":{"line":89,"column":20},"end":{"line":89,"column":29}},"37":{"start":{"line":91,"column":2},"end":{"line":102,"column":21}},"38":{"start":{"line":93,"column":20},"end":{"line":93,"column":73}},"39":{"start":{"line":94,"column":4},"end":{"line":96,"column":5}},"40":{"start":{"line":95,"column":5},"end":{"line":95,"column":55}},"41":{"start":{"line":98,"column":4},"end":{"line":98,"column":31}},"42":{"start":{"line":99,"column":4},"end":{"line":99,"column":38}},"43":{"start":{"line":101,"column":18},"end":{"line":101,"column":52}},"44":{"start":{"line":102,"column":15},"end":{"line":102,"column":19}},"45":{"start":{"line":106,"column":22},"end":{"line":106,"column":45}},"46":{"start":{"line":107,"column":20},"end":{"line":107,"column":29}},"47":{"start":{"line":108,"column":2},"end":{"line":109,"column":42}},"48":{"start":{"line":109,"column":15},"end":{"line":109,"column":40}},"49":{"start":{"line":113,"column":20},"end":{"line":113,"column":29}},"50":{"start":{"line":114,"column":2},"end":{"line":115,"column":30}},"51":{"start":{"line":115,"column":15},"end":{"line":115,"column":28}},"52":{"start":{"line":119,"column":0},"end":{"line":119,"column":22}}},"fnMap":{"0":{"name":"(anonymous_0)","decl":{"start":{"line":7,"column":26},"end":{"line":7,"column":27}},"loc":{"start":{"line":7,"column":38},"end":{"line":9,"column":1}},"line":7},"1":{"name":"(anonymous_1)","decl":{"start":{"line":11,"column":18},"end":{"line":11,"column":19}},"loc":{"start":{"line":11,"column":29},"end":{"line":28,"column":1}},"line":11},"2":{"name":"(anonymous_2)","decl":{"start":{"line":31,"column":1},"end":{"line":31,"column":2}},"loc":{"start":{"line":31,"column":27},"end":{"line":53,"column":2}},"line":31},"3":{"name":"(anonymous_3)","decl":{"start":{"line":49,"column":31},"end":{"line":49,"column":32}},"loc":{"start":{"line":49,"column":40},"end":{"line":49,"column":65}},"line":49},"4":{"name":"(anonymous_4)","decl":{"start":{"line":55,"column":1},"end":{"line":55,"column":2}},"loc":{"start":{"line":55,"column":20},"end":{"line":57,"column":2}},"line":55},"5":{"name":"(anonymous_5)","decl":{"start":{"line":59,"column":1},"end":{"line":59,"column":2}},"loc":{"start":{"line":59,"column":19},"end":{"line":77,"column":2}},"line":59},"6":{"name":"(anonymous_6)","decl":{"start":{"line":63,"column":9},"end":{"line":63,"column":10}},"loc":{"start":{"line":63,"column":15},"end":{"line":63,"column":37}},"line":63},"7":{"name":"(anonymous_7)","decl":{"start":{"line":64,"column":9},"end":{"line":64,"column":10}},"loc":{"start":{"line":64,"column":17},"end":{"line":64,"column":80}},"line":64},"8":{"name":"(anonymous_8)","decl":{"start":{"line":65,"column":9},"end":{"line":65,"column":10}},"loc":{"start":{"line":65,"column":17},"end":{"line":76,"column":4}},"line":65},"9":{"name":"(anonymous_9)","decl":{"start":{"line":79,"column":1},"end":{"line":79,"column":2}},"loc":{"start":{"line":79,"column":22},"end":{"line":103,"column":2}},"line":79},"10":{"name":"(anonymous_10)","decl":{"start":{"line":92,"column":9},"end":{"line":92,"column":10}},"loc":{"start":{"line":92,"column":15},"end":{"line":100,"column":4}},"line":92},"11":{"name":"(anonymous_11)","decl":{"start":{"line":101,"column":9},"end":{"line":101,"column":10}},"loc":{"start":{"line":101,"column":18},"end":{"line":101,"column":52}},"line":101},"12":{"name":"(anonymous_12)","decl":{"start":{"line":102,"column":9},"end":{"line":102,"column":10}},"loc":{"start":{"line":102,"column":15},"end":{"line":102,"column":19}},"line":102},"13":{"name":"(anonymous_13)","decl":{"start":{"line":105,"column":1},"end":{"line":105,"column":2}},"loc":{"start":{"line":105,"column":13},"end":{"line":110,"column":2}},"line":105},"14":{"name":"(anonymous_14)","decl":{"start":{"line":109,"column":9},"end":{"line":109,"column":10}},"loc":{"start":{"line":109,"column":15},"end":{"line":109,"column":40}},"line":109},"15":{"name":"(anonymous_15)","decl":{"start":{"line":112,"column":1},"end":{"line":112,"column":2}},"loc":{"start":{"line":112,"column":9},"end":{"line":116,"column":2}},"line":112},"16":{"name":"(anonymous_16)","decl":{"start":{"line":115,"column":9},"end":{"line":115,"column":10}},"loc":{"start":{"line":115,"column":15},"end":{"line":115,"column":28}},"line":115}},"branchMap":{"0":{"loc":{"start":{"line":22,"column":1},"end":{"line":25,"column":2}},"type":"if","locations":[{"start":{"line":22,"column":1},"end":{"line":25,"column":2}},{"start":{"line":22,"column":1},"end":{"line":25,"column":2}}],"line":22},"1":{"loc":{"start":{"line":22,"column":5},"end":{"line":22,"column":35}},"type":"binary-expr","locations":[{"start":{"line":22,"column":5},"end":{"line":22,"column":20}},{"start":{"line":22,"column":24},"end":{"line":22,"column":35}}],"line":22},"2":{"loc":{"start":{"line":23,"column":18},"end":{"line":23,"column":66}},"type":"binary-expr","locations":[{"start":{"line":23,"column":18},"end":{"line":23,"column":33}},{"start":{"line":23,"column":37},"end":{"line":23,"column":66}}],"line":23},"3":{"loc":{"start":{"line":39,"column":3},"end":{"line":39,"column":44}},"type":"cond-expr","locations":[{"start":{"line":39,"column":31},"end":{"line":39,"column":38}},{"start":{"line":39,"column":41},"end":{"line":39,"column":44}}],"line":39},"4":{"loc":{"start":{"line":43,"column":2},"end":{"line":46,"column":3}},"type":"if","locations":[{"start":{"line":43,"column":2},"end":{"line":46,"column":3}},{"start":{"line":43,"column":2},"end":{"line":46,"column":3}}],"line":43},"5":{"loc":{"start":{"line":48,"column":2},"end":{"line":50,"column":3}},"type":"if","locations":[{"start":{"line":48,"column":2},"end":{"line":50,"column":3}},{"start":{"line":48,"column":2},"end":{"line":50,"column":3}}],"line":48},"6":{"loc":{"start":{"line":64,"column":17},"end":{"line":64,"column":80}},"type":"cond-expr","locations":[{"start":{"line":64,"column":46},"end":{"line":64,"column":73}},{"start":{"line":64,"column":76},"end":{"line":64,"column":80}}],"line":64},"7":{"loc":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"type":"if","locations":[{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},{"start":{"line":66,"column":4},"end":{"line":68,"column":5}}],"line":66},"8":{"loc":{"start":{"line":66,"column":8},"end":{"line":66,"column":43}},"type":"binary-expr","locations":[{"start":{"line":66,"column":8},"end":{"line":66,"column":26}},{"start":{"line":66,"column":30},"end":{"line":66,"column":43}}],"line":66},"9":{"loc":{"start":{"line":70,"column":4},"end":{"line":73,"column":5}},"type":"if","locations":[{"start":{"line":70,"column":4},"end":{"line":73,"column":5}},{"start":{"line":70,"column":4},"end":{"line":73,"column":5}}],"line":70},"10":{"loc":{"start":{"line":70,"column":8},"end":{"line":70,"column":69}},"type":"binary-expr","locations":[{"start":{"line":70,"column":8},"end":{"line":70,"column":40}},{"start":{"line":70,"column":44},"end":{"line":70,"column":69}}],"line":70},"11":{"loc":{"start":{"line":75,"column":11},"end":{"line":75,"column":55}},"type":"cond-expr","locations":[{"start":{"line":75,"column":38},"end":{"line":75,"column":42}},{"start":{"line":75,"column":45},"end":{"line":75,"column":55}}],"line":75},"12":{"loc":{"start":{"line":75,"column":12},"end":{"line":75,"column":34}},"type":"binary-expr","locations":[{"start":{"line":75,"column":12},"end":{"line":75,"column":19}},{"start":{"line":75,"column":23},"end":{"line":75,"column":34}}],"line":75},"13":{"loc":{"start":{"line":81,"column":2},"end":{"line":83,"column":3}},"type":"if","locations":[{"start":{"line":81,"column":2},"end":{"line":83,"column":3}},{"start":{"line":81,"column":2},"end":{"line":83,"column":3}}],"line":81},"14":{"loc":{"start":{"line":85,"column":2},"end":{"line":87,"column":3}},"type":"if","locations":[{"start":{"line":85,"column":2},"end":{"line":87,"column":3}},{"start":{"line":85,"column":2},"end":{"line":87,"column":3}}],"line":85},"15":{"loc":{"start":{"line":93,"column":20},"end":{"line":93,"column":73}},"type":"cond-expr","locations":[{"start":{"line":93,"column":49},"end":{"line":93,"column":65}},{"start":{"line":93,"column":69},"end":{"line":93,"column":73}}],"line":93},"16":{"loc":{"start":{"line":94,"column":4},"end":{"line":96,"column":5}},"type":"if","locations":[{"start":{"line":94,"column":4},"end":{"line":96,"column":5}},{"start":{"line":94,"column":4},"end":{"line":96,"column":5}}],"line":94}},"s":{"0":1,"1":1,"2":1,"3":0,"4":1,"5":3,"6":3,"7":2,"8":2,"9":1,"10":197,"11":197,"12":197,"13":3,"14":3,"15":197,"16":188,"17":1,"18":197,"19":95,"20":46,"21":46,"22":46,"23":46,"24":46,"25":46,"26":9,"27":37,"28":5,"29":5,"30":32,"31":39,"32":39,"33":34,"34":39,"35":1,"36":39,"37":39,"38":39,"39":39,"40":1,"41":38,"42":38,"43":38,"44":38,"45":10,"46":10,"47":10,"48":10,"49":163,"50":163,"51":163,"52":1},"f":{"0":0,"1":3,"2":197,"3":1,"4":95,"5":46,"6":46,"7":46,"8":46,"9":39,"10":39,"11":38,"12":38,"13":10,"14":10,"15":163,"16":163},"b":{"0":[2,1],"1":[3,3],"2":[2,2],"3":[2,195],"4":[3,194],"5":[188,9],"6":[37,9],"7":[9,37],"8":[46,37],"9":[5,32],"10":[37,13],"11":[1,31],"12":[32,1],"13":[34,5],"14":[1,38],"15":[6,33],"16":[1,38]},"_coverageSchema":"1a1c01bbd47fc00a2c39e90264f33305004495a9","hash":"a1f9f50840413fbf8dec11cc75e741387da8a6d0","contentHash":"0ecb4ae8fe157ca1a77008538c0b536709aa7c13d364d4266adea5319bee04f1"}}

package/.nyc_output/processinfo/17c338d1-cd21-4d2f-9d97-398f18a945cf.json

@@ -0,0 +1 @@
+{"parent":"67b1f344-0eec-41a3-a665-c824c346e898","pid":4476,"argv":["/Users/jaredwray/.nvm/versions/node/v16.13.1/bin/node","/Users/jaredwray/src/github.com/jaredwray/keyv/node_modules/update-notifier/check.js","{\"pkg\":{\"name\":\"ava\",\"version\":\"3.15.0\"},\"distTag\":\"latest\"}"],"execArgv":[],"cwd":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv","time":1643754172416,"ppid":4475,"coverageFilename":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/.nyc_output/17c338d1-cd21-4d2f-9d97-398f18a945cf.json","externalId":"","uuid":"17c338d1-cd21-4d2f-9d97-398f18a945cf","files":[]}

package/.nyc_output/processinfo/67b1f344-0eec-41a3-a665-c824c346e898.json

@@ -0,0 +1 @@
+{"parent":null,"pid":4475,"argv":["/Users/jaredwray/.nvm/versions/node/v16.13.1/bin/node","/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/node_modules/.bin/ava","--serial"],"execArgv":[],"cwd":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv","time":1643754172273,"ppid":4474,"coverageFilename":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/.nyc_output/67b1f344-0eec-41a3-a665-c824c346e898.json","externalId":"","uuid":"67b1f344-0eec-41a3-a665-c824c346e898","files":[]}

package/.nyc_output/processinfo/adb04494-7d0a-443f-9130-94b19c3fa19c.json

@@ -0,0 +1 @@
+{"parent":"67b1f344-0eec-41a3-a665-c824c346e898","pid":4477,"argv":["/Users/jaredwray/.nvm/versions/node/v16.13.1/bin/node","/Users/jaredwray/src/github.com/jaredwray/keyv/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv","time":1643754172556,"ppid":4475,"coverageFilename":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/.nyc_output/adb04494-7d0a-443f-9130-94b19c3fa19c.json","externalId":"","uuid":"adb04494-7d0a-443f-9130-94b19c3fa19c","files":["/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/src/index.js"]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"17c338d1-cd21-4d2f-9d97-398f18a945cf":{"parent":"67b1f344-0eec-41a3-a665-c824c346e898","children":[]},"67b1f344-0eec-41a3-a665-c824c346e898":{"parent":null,"children":["17c338d1-cd21-4d2f-9d97-398f18a945cf","adb04494-7d0a-443f-9130-94b19c3fa19c"]},"adb04494-7d0a-443f-9130-94b19c3fa19c":{"parent":"67b1f344-0eec-41a3-a665-c824c346e898","children":[]}},"files":{"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/keyv/src/index.js":["adb04494-7d0a-443f-9130-94b19c3fa19c"]},"externalIds":{}}

package/README.md

@@ -1,13 +1,13 @@
 <h1 align="center">
-	<img width="250" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">
+	<img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv">
 	<br>
 	<br>
 </h1>
 
 > Simple key-value storage with support for multiple backends
 
-[![Build Status](https://travis-ci.org/lukechilds/keyv.svg?branch=master)](https://travis-ci.org/lukechilds/keyv)
-[![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv?branch=master)
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/master/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
 [![npm](https://img.shields.io/npm/dm/keyv.svg)](https://www.npmjs.com/package/keyv)
 [![npm](https://img.shields.io/npm/v/keyv.svg)](https://www.npmjs.com/package/keyv)
 
@@ -44,6 +44,7 @@ npm install --save @keyv/mongo
 npm install --save @keyv/sqlite
 npm install --save @keyv/postgres
 npm install --save @keyv/mysql
+npm install --save @keyv/etcd
 ```
 
 Create a new Keyv instance, passing your connection string if applicable. Keyv will automatically load the correct storage adapter.
@@ -58,6 +59,7 @@ const keyv = new Keyv('mongodb://user:pass@localhost:27017/dbname');
 const keyv = new Keyv('sqlite://path/to/database.sqlite');
 const keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname');
 const keyv = new Keyv('mysql://user:pass@localhost:3306/dbname');
+const keyv = new Keyv('etcd://localhost:2379');
 
 // Handle DB connection errors
 keyv.on('error', err => console.log('Connection Error', err));
@@ -100,15 +102,16 @@ const keyv = new Keyv({ serialize: JSON.stringify, deserialize: JSON.parse });
 
 ## Official Storage Adapters
 
-The official storage adapters are covered by [over 150 integration tests](https://travis-ci.org/lukechilds/keyv/jobs/260418145) to guarantee consistent behaviour. They are lightweight, efficient wrappers over the DB clients making use of indexes and native TTLs where available.
+The official storage adapters are covered by [over 150 integration tests](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml) to guarantee consistent behaviour. They are lightweight, efficient wrappers over the DB clients making use of indexes and native TTLs where available.
 
-Database | Adapter | Native TTL | Status
----|---|---|---
-Redis | [@keyv/redis](https://github.com/lukechilds/keyv-redis) | Yes | [![Build Status](https://travis-ci.org/lukechilds/keyv-redis.svg?branch=master)](https://travis-ci.org/lukechilds/keyv-redis) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv-redis/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv-redis?branch=master)
-MongoDB | [@keyv/mongo](https://github.com/lukechilds/keyv-mongo) | Yes | [![Build Status](https://travis-ci.org/lukechilds/keyv-mongo.svg?branch=master)](https://travis-ci.org/lukechilds/keyv-mongo) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv-mongo/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv-mongo?branch=master)
-SQLite | [@keyv/sqlite](https://github.com/lukechilds/keyv-sqlite) | No | [![Build Status](https://travis-ci.org/lukechilds/keyv-sqlite.svg?branch=master)](https://travis-ci.org/lukechilds/keyv-sqlite) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv-sqlite/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv-sqlite?branch=master)
-PostgreSQL | [@keyv/postgres](https://github.com/lukechilds/keyv-postgres) | No | [![Build Status](https://travis-ci.org/lukechilds/keyv-postgres.svg?branch=master)](https://travis-ci.org/lukechildskeyv-postgreskeyv) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv-postgres/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv-postgres?branch=master)
-MySQL | [@keyv/mysql](https://github.com/lukechilds/keyv-mysql) | No | [![Build Status](https://travis-ci.org/lukechilds/keyv-mysql.svg?branch=master)](https://travis-ci.org/lukechilds/keyv-mysql) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/keyv-mysql/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/keyv-mysql?branch=master)
+Database | Adapter | Native TTL
+---|---|---
+Redis | [@keyv/redis](https://github.com/jaredwray/keyv/tree/master/packages/redis) | Yes
+MongoDB | [@keyv/mongo](https://github.com/jaredwray/keyv/tree/master/packages/mongo) | Yes 
+SQLite | [@keyv/sqlite](https://github.com/jaredwray/keyv/tree/master/packages/sqlite) | No 
+PostgreSQL | [@keyv/postgres](https://github.com/jaredwray/keyv/tree/master/packages/postgres) | No 
+MySQL | [@keyv/mysql](https://github.com/jaredwray/keyv/tree/master/packages/mysql) | No 
+Etcd | [@keyv/etcd](https://github.com/jaredwray/keyv/tree/master/packages/etcd) | Yes
 
 ## Third-party Storage Adapters
 
@@ -142,9 +145,12 @@ 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-lru](https://www.npmjs.com/package/keyv-lru) - LRU storage adapter for Keyv
+- [keyv-null](https://www.npmjs.com/package/keyv-null) - Null 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
+- [keyv-memcache](https://github.com/jaredwray/keyv/tree/master/packages/memcache) - Memcache storage adapter for Keyv
+- [keyv-azuretable](https://github.com/howlowck/keyv-azuretable) - Azure Table Storage/API adapter for Keyv
 
 ## Add Cache Support to your Module
 
@@ -283,6 +289,84 @@ Delete all entries in the current namespace.
 
 Returns a promise which is resolved when the entries have been cleared.
 
+# How to Contribute
+
+In this section of the documentation we will cover:
+
+1) How to set up this repository locally
+2) How to get started with running commands
+3) How to contribute changes using Pull Requests
+
+## Dependencies
+
+This package requires the following dependencies to run:
+
+1) [Yarn V1](https://yarnpkg.com/getting-started/install)
+2) [Lerna](https://lerna.js.org/)
+3) [Docker](https://docs.docker.com/get-docker/)
+
+## Setting up your workspace
+
+To contribute to this repository, start by setting up this project locally:
+
+1) Fork this repository into your Git account
+2) Clone the forked repository to your local directory using `git clone`
+3) Install any of the above missing dependencies
+
+## Launching the project
+
+Once the project is installed locally, you are ready to start up its services:
+
+1) Ensure that your Docker service is running.
+2) From the root directory of your project, run the `yarn` command in the command prompt to install yarn.
+3) Run the `yarn bootstrap` command to  install any necessary dependencies.
+4) Run `yarn test:services:start` to start up this project's Docker container. The container will launch all services within your workspace.
+
+## Available Commands
+
+Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, `lerna`, and `docker` commands.
+
+Here, we'll cover the primary commands that can be executed from the root directory. Unless otherwise noted, these commands can also be executed from a subpackage. If executed from a subpackage, they will only affect that subpackage, rather than the entire workspace.
+
+### `yarn`
+
+The `yarn` command installs yarn in the workspace.
+
+### `yarn bootstrap`
+
+The `yarn bootstrap` command installs all dependencies in the workspace.
+
+### `yarn test:services:start`
+
+The `yarn test:services:start` command starts up the project's Docker container, launching all services in the workspace. This command must be executed from the root directory.
+
+### `yarn test:services:stop`
+
+The `yarn test:services:stop` command brings down the project's Docker container, halting all services. This command must be executed from the root directory.
+
+### `yarn test`
+
+The `yarn test` command runs all tests in the workspace.
+
+### `yarn clean`
+
+The `yarn clean` command removes yarn and all dependencies installed by yarn. After executing this command, you must repeat the steps in *Setting up your workspace* to rebuild your workspace.
+
+## Contributing Changes
+
+Now that you've set up your workspace, you're ready to contribute changes to the `keyv` repository.
+
+1) Make any changes that you would like to contribute in your local workspace.
+2) After making these changes, ensure that the project's tests still pass by executing the `yarn test` command in the root directory.
+3) Commit your changes and push them to your forked repository.
+4) Navigate to the original `keyv` repository and go the *Pull Requests* tab.
+5) Click the *New pull request* button, and open a pull request for the branch in your repository that contains your changes.
+6) Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
+7) Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
+8) Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the `keyv` repository.
+
+If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+
 ## License
 
-MIT © Luke Childs
+MIT © Jared Wray & Luke Childs

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "keyv",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Simple key-value storage with support for multiple backends",
   "main": "src/index.js",
   "scripts": {
-    "test": "xo && nyc ava test/keyv.js",
-    "test:full": "xo && nyc ava --serial",
-    "coverage": "nyc report --reporter=text-lcov | coveralls"
+    "test": "xo && nyc ava --serial",
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
+    "clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
   },
   "xo": {
-    "extends": "xo-lukechilds"
+    "extends": "xo-lukechilds",
+    "rules": {
+      "unicorn/prefer-module": 0
+    }
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lukechilds/keyv.git"
+    "url": "git+https://github.com/jaredwray/keyv.git"
   },
   "keywords": [
     "key",
@@ -22,28 +25,24 @@
     "cache",
     "ttl"
   ],
-  "author": "Luke Childs <lukechilds123@gmail.com> (http://lukechilds.co.uk)",
+  "author": "Jared Wray <me@jaredwray.com> (http://jaredwray.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/lukechilds/keyv/issues"
+    "url": "https://github.com/jaredwray/keyv/issues"
   },
-  "homepage": "https://github.com/lukechilds/keyv",
+  "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
     "json-buffer": "3.0.1"
   },
   "devDependencies": {
-    "ava": "^2.2.0",
-    "coveralls": "^3.0.0",
-    "eslint-config-xo-lukechilds": "^1.0.0",
-    "@keyv/mongo": "*",
-    "@keyv/mysql": "*",
-    "@keyv/postgres": "*",
-    "@keyv/redis": "*",
-    "@keyv/sqlite": "*",
     "@keyv/test-suite": "*",
-    "nyc": "^14.1.1",
+    "ava": "^3.15.0",
+    "eslint-config-xo-lukechilds": "^1.0.0",
+    "eslint-plugin-promise": "^5.1.1",
+    "nyc": "^15.1.0",
+    "pify": "5.0.0",
     "this": "^1.0.2",
     "timekeeper": "^2.0.0",
-    "xo": "^0.25.3"
+    "xo": "^0.46.3"
   }
 }

package/src/index.js

@@ -3,44 +3,50 @@
 const EventEmitter = require('events');
 const JSONB = require('json-buffer');
 
-const loadStore = opts => {
+// eslint-disable-next-line no-extend-native
+BigInt.prototype.toJSON = function () {
+	return this.toString();
+};
+
+const loadStore = options => {
 	const adapters = {
-		redis: () => require('@keyv/redis'),
-		mongodb: () => require('@keyv/mongo'),
-		mongo: () => require('@keyv/mongo'),
-		sqlite: () => require('@keyv/sqlite'),
-		postgresql: () => require('@keyv/postgres'),
-		postgres: () => require('@keyv/postgres'),
-		mysql: () => require('@keyv/mysql')
+		redis: '@keyv/redis',
+		mongodb: '@keyv/mongo',
+		mongo: '@keyv/mongo',
+		sqlite: '@keyv/sqlite',
+		postgresql: '@keyv/postgres',
+		postgres: '@keyv/postgres',
+		mysql: '@keyv/mysql',
+		etcd: '@keyv/etcd',
 	};
-	if (opts.adapter || opts.uri) {
-		const adapter = opts.adapter || /^[^:]*/.exec(opts.uri)[0];
-		return new (adapters[adapter]())(opts);
+	if (options.adapter || options.uri) {
+		const adapter = options.adapter || /^[^:]*/.exec(options.uri)[0];
+		return new (require(adapters[adapter]))(options);
 	}
 
 	return new Map();
 };
 
 class Keyv extends EventEmitter {
-	constructor(uri, opts) {
+	constructor(uri, options) {
 		super();
 		this.opts = Object.assign(
 			{
 				namespace: 'keyv',
 				serialize: JSONB.stringify,
-				deserialize: JSONB.parse
+				deserialize: JSONB.parse,
 			},
 			(typeof uri === 'string') ? { uri } : uri,
-			opts
+			options,
 		);
 
 		if (!this.opts.store) {
-			const adapterOpts = Object.assign({}, this.opts);
-			this.opts.store = loadStore(adapterOpts);
+			const adapterOptions = Object.assign({}, this.opts);
+			this.opts.store = loadStore(adapterOptions);
 		}
 
 		if (typeof this.opts.store.on === 'function') {
-			this.opts.store.on('error', err => this.emit('error', err));
+			this.opts.store.on('error', error => this.emit('error', error));
 		}
 
 		this.opts.store.namespace = this.opts.namespace;
@@ -50,16 +56,14 @@ class Keyv extends EventEmitter {
 		return `${this.opts.namespace}:${key}`;
 	}
 
-	get(key, opts) {
+	get(key, options) {
 		const keyPrefixed = this._getKeyPrefix(key);
 		const { store } = this.opts;
 		return Promise.resolve()
 			.then(() => store.get(keyPrefixed))
+			.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : data)
 			.then(data => {
-				return (typeof data === 'string') ? this.opts.deserialize(data) : data;
-			})
-			.then(data => {
-				if (data === undefined) {
+				if (data === undefined || data === null) {
 					return undefined;
 				}
 
@@ -68,7 +72,7 @@ class Keyv extends EventEmitter {
 					return undefined;
 				}
 
-				return (opts && opts.raw) ? data : data.value;
+				return (options && options.raw) ? data : data.value;
 			});
 	}
 
@@ -87,6 +91,10 @@ class Keyv extends EventEmitter {
 		return Promise.resolve()
 			.then(() => {
 				const expires = (typeof ttl === 'number') ? (Date.now() + ttl) : null;
+				if (typeof value === 'symbol') {
+					this.emit('error', 'symbol cannot be serialized');
+				}
+
 				value = { value, expires };
 				return this.opts.serialize(value);
 			})

package/test/test.js

@@ -0,0 +1,130 @@
+const test = require('ava');
+const { default: keyvTestSuite, keyvOfficialTests } = require('@keyv/test-suite');
+const Keyv = require('this');
+const tk = require('timekeeper');
+const KeyvSqlite = require('@keyv/sqlite');
+
+keyvOfficialTests(test, Keyv, 'sqlite://test/testdb.sqlite', 'sqlite://non/existent/database.sqlite');
+const store = () => new KeyvSqlite({ uri: 'sqlite://test/testdb.sqlite', busyTimeout: 3000 });
+keyvTestSuite(test, Keyv, store);
+
+test.serial('Keyv is a class', t => {
+	t.is(typeof Keyv, 'function');
+	t.throws(() => Keyv()); // eslint-disable-line new-cap
+	t.notThrows(() => new Keyv());
+});
+
+test.serial('Keyv accepts storage adapters', async t => {
+	const store = new Map();
+	const keyv = new Keyv({ store });
+	t.is(store.size, 0);
+	await keyv.set('foo', 'bar');
+	t.is(await keyv.get('foo'), 'bar');
+	t.is(store.size, 1);
+});
+
+test.serial('Keyv passes tll info to stores', async t => {
+	t.plan(1);
+	const store = new Map();
+	const storeSet = store.set;
+	store.set = (key, value, ttl) => {
+		t.is(ttl, 100);
+		storeSet.call(store, key, value, ttl);
+	};
+
+	const keyv = new Keyv({ store });
+	await keyv.set('foo', 'bar', 100);
+});
+
+test.serial('Keyv respects default tll option', async t => {
+	const store = new Map();
+	const keyv = new Keyv({ store, ttl: 100 });
+	await keyv.set('foo', 'bar');
+	t.is(await keyv.get('foo'), 'bar');
+	tk.freeze(Date.now() + 150);
+	t.is(await keyv.get('foo'), undefined);
+	t.is(store.size, 0);
+	tk.reset();
+});
+
+test.serial('.set(key, val, ttl) overwrites default tll option', async t => {
+	const startTime = Date.now();
+	tk.freeze(startTime);
+	const store = new Map();
+	const keyv = new Keyv({ store, ttl: 200 });
+	await keyv.set('foo', 'bar');
+	await keyv.set('fizz', 'buzz', 100);
+	await keyv.set('ping', 'pong', 300);
+	t.is(await keyv.get('foo'), 'bar');
+	t.is(await keyv.get('fizz'), 'buzz');
+	t.is(await keyv.get('ping'), 'pong');
+	tk.freeze(startTime + 150);
+	t.is(await keyv.get('foo'), 'bar');
+	t.is(await keyv.get('fizz'), undefined);
+	t.is(await keyv.get('ping'), 'pong');
+	tk.freeze(startTime + 250);
+	t.is(await keyv.get('foo'), undefined);
+	t.is(await keyv.get('ping'), 'pong');
+	tk.freeze(startTime + 350);
+	t.is(await keyv.get('ping'), undefined);
+	tk.reset();
+});
+
+test.serial('.set(key, val, ttl) where ttl is "0" overwrites default tll option and sets key to never expire', async t => {
+	const startTime = Date.now();
+	tk.freeze(startTime);
+	const store = new Map();
+	const keyv = new Keyv({ store, ttl: 200 });
+	await keyv.set('foo', 'bar', 0);
+	t.is(await keyv.get('foo'), 'bar');
+	tk.freeze(startTime + 250);
+	t.is(await keyv.get('foo'), 'bar');
+	tk.reset();
+});
+
+test.serial('.get(key, {raw: true}) returns the raw object instead of the value', async t => {
+	const store = new Map();
+	const keyv = new Keyv({ store });
+	await keyv.set('foo', 'bar');
+	const value = await keyv.get('foo');
+	const rawObject = await keyv.get('foo', { raw: true });
+	t.is(value, 'bar');
+	t.is(rawObject.value, 'bar');
+});
+
+test.serial('Keyv uses custom serializer when provided instead of json-buffer', async t => {
+	t.plan(3);
+	const store = new Map();
+	const serialize = data => {
+		t.pass();
+		return JSON.stringify(data);
+	};
+
+	const deserialize = data => {
+		t.pass();
+		return JSON.parse(data);
+	};
+
+	const keyv = new Keyv({ store, serialize, deserialize });
+	await keyv.set('foo', 'bar');
+	t.is(await keyv.get('foo'), 'bar');
+});
+
+test.serial('Keyv supports async serializer/deserializer', async t => {
+	t.plan(3);
+	const store = new Map();
+
+	const serialize = async data => {
+		t.pass();
+		return JSON.stringify(data);
+	};
+
+	const deserialize = async data => {
+		t.pass();
+		return JSON.parse(data);
+	};
+
+	const keyv = new Keyv({ store, serialize, deserialize });
+	await keyv.set('foo', 'bar');
+	t.is(await keyv.get('foo'), 'bar');
+});

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Luke Childs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.