@workablehr/idb - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

es/index.js

@@ -10,3 +10,12 @@ import { get as indexDBGet, set as indexDBSet, Store, clear as indexDBClear, del as indexDBDelete } from "idb-keyval";
 };
+/**
+ * @description A simple cache mechanisms that is based on IndexDB.
+ * @example
+ * const { store, set, get, clear, del } = makeIDB("workable-store");
+ *
+ * idb.get("myKey", { fetch: performFetch, maxAge: 100 });
+ * // if 'myKey' does not exists, it fetches and stores the result for 100 seconds
+ */
 
+
 export default (function (name) {
@@ -13,0 +22,0 @@ if (!name) {

lib/index.js

@@ -18,3 +18,12 @@ "use strict";
 };
+/**
+ * @description A simple cache mechanisms that is based on IndexDB.
+ * @example
+ * const { store, set, get, clear, del } = makeIDB("workable-store");
+ *
+ * idb.get("myKey", { fetch: performFetch, maxAge: 100 });
+ * // if 'myKey' does not exists, it fetches and stores the result for 100 seconds
+ */
 
+
 var _default = function _default(name) {
@@ -21,0 +30,0 @@ if (!name) {

package.json

@@ -5,3 +5,3 @@ {
   "license": "UNLICENSED",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "lib/index.js",
@@ -8,0 +8,0 @@ "module": "es/index.js",

src/index.js

@@ -13,2 +13,11 @@ import {
 
+/**
+ * @description A simple cache mechanisms that is based on IndexDB.
+ * @example
+ * const { store, set, get, clear, del } = makeIDB("workable-store");
+ *
+ * idb.get("myKey", { fetch: performFetch, maxAge: 100 });
+ * // if 'myKey' does not exists, it fetches and stores the result for 100 seconds
+ */
+
 export default name => {
@@ -15,0 +24,0 @@ if (!name) {

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44204

increased by4.32%

Number of package files

10

increased by11.11%

Lines of code

1150

increased by2.13%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

49

increased byInfinity%

No dependency changes