interface-store - npm Package Compare versions

Comparing version 5.1.4 to 5.1.5

dist/src/index.d.ts

 /**
+ * @packageDocumentation
+ *
+ * An abstraction of the Datastore/Blockstore codebases.
+ */
+/**
  * An iterable or async iterable of values
@@ -30,3 +35,3 @@ */
      */
-    has: (key: Key, options?: AbortOptions & HasOptionsExtension) => Await<boolean>;
+    has(key: Key, options?: AbortOptions & HasOptionsExtension): Await<boolean>;
     /**
@@ -41,3 +46,3 @@ * Store the passed value under the passed key
      */
-    put: (key: Key, val: Value, options?: AbortOptions & PutOptionsExtension) => Await<Key>;
+    put(key: Key, val: Value, options?: AbortOptions & PutOptionsExtension): Await<Key>;
     /**
@@ -55,3 +60,3 @@ * Store the given key/value pairs
      */
-    putMany: (source: AwaitIterable<Pair>, options?: AbortOptions & PutManyOptionsExtension) => AwaitIterable<Key>;
+    putMany(source: AwaitIterable<Pair>, options?: AbortOptions & PutManyOptionsExtension): AwaitIterable<Key>;
     /**
@@ -67,3 +72,3 @@ * Retrieve the value stored under the given key
      */
-    get: (key: Key, options?: AbortOptions & GetOptionsExtension) => Await<Value>;
+    get(key: Key, options?: AbortOptions & GetOptionsExtension): Await<Value>;
     /**
@@ -80,3 +85,3 @@ * Retrieve values for the passed keys
      */
-    getMany: (source: AwaitIterable<Key>, options?: AbortOptions & GetManyOptionsExtension) => AwaitIterable<Pair>;
+    getMany(source: AwaitIterable<Key>, options?: AbortOptions & GetManyOptionsExtension): AwaitIterable<Pair>;
     /**
@@ -92,3 +97,3 @@ * Remove the record for the passed key
      */
-    delete: (key: Key, options?: AbortOptions & DeleteOptionsExtension) => Await<void>;
+    delete(key: Key, options?: AbortOptions & DeleteOptionsExtension): Await<void>;
     /**
@@ -107,4 +112,4 @@ * Remove values for the passed keys
      */
-    deleteMany: (source: AwaitIterable<Key>, options?: AbortOptions & DeleteManyOptionsExtension) => AwaitIterable<Key>;
+    deleteMany(source: AwaitIterable<Key>, options?: AbortOptions & DeleteManyOptionsExtension): AwaitIterable<Key>;
 }
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "interface-store",
-  "version": "5.1.4",
+  "version": "5.1.5",
   "description": "A generic interface for storing and retrieving data",
@@ -35,3 +35,6 @@ "license": "Apache-2.0 OR MIT",
   "eslintConfig": {
-    "extends": "ipfs"
+    "extends": "ipfs",
+    "parserOptions": {
+      "project": true
+    }
   },
@@ -127,7 +130,8 @@ "release": {
     "clean": "aegir clean",
-    "release": "aegir release"
+    "release": "aegir release",
+    "dep-check": "aegir dep-check"
   },
   "devDependencies": {
-    "aegir": "^40.0.8"
+    "aegir": "^41.1.9"
   }
 }

README.md

@@ -1,3 +0,1 @@
-# interface-store <!-- omit in toc -->
-
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
@@ -10,10 +8,7 @@ [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 
-## Table of contents <!-- omit in toc -->
+# About
 
-- [Install](#install)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribute](#contribute)
+An abstraction of the Datastore/Blockstore codebases.
 
-## Install
+# Install
 
@@ -24,7 +19,7 @@ ```console
 
-## API Docs
+# API Docs
 
 - <https://ipfs.github.io/js-stores/modules/interface_store.html>
 
-## License
+# License
 
@@ -36,3 +31,3 @@ Licensed under either of
 
-## Contribute
+# Contribute
 
@@ -39,0 +34,0 @@ Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues).

src/index.ts

@@ -8,2 +8,8 @@ /* eslint-disable @typescript-eslint/ban-types */
 /**
+ * @packageDocumentation
+ *
+ * An abstraction of the Datastore/Blockstore codebases.
+ */
+
+/**
  * An iterable or async iterable of values
@@ -43,3 +49,3 @@ */
    */
-  has: (key: Key, options?: AbortOptions & HasOptionsExtension) => Await<boolean>
+  has(key: Key, options?: AbortOptions & HasOptionsExtension): Await<boolean>
 
@@ -55,3 +61,3 @@ /**
    */
-  put: (key: Key, val: Value, options?: AbortOptions & PutOptionsExtension) => Await<Key>
+  put(key: Key, val: Value, options?: AbortOptions & PutOptionsExtension): Await<Key>
 
@@ -70,6 +76,6 @@ /**
    */
-  putMany: (
+  putMany(
     source: AwaitIterable<Pair>,
     options?: AbortOptions & PutManyOptionsExtension
-  ) => AwaitIterable<Key>
+  ): AwaitIterable<Key>
 
@@ -86,3 +92,3 @@ /**
    */
-  get: (key: Key, options?: AbortOptions & GetOptionsExtension) => Await<Value>
+  get(key: Key, options?: AbortOptions & GetOptionsExtension): Await<Value>
 
@@ -100,6 +106,6 @@ /**
    */
-  getMany: (
+  getMany(
     source: AwaitIterable<Key>,
     options?: AbortOptions & GetManyOptionsExtension
-  ) => AwaitIterable<Pair>
+  ): AwaitIterable<Pair>
 
@@ -116,3 +122,3 @@ /**
    */
-  delete: (key: Key, options?: AbortOptions & DeleteOptionsExtension) => Await<void>
+  delete(key: Key, options?: AbortOptions & DeleteOptionsExtension): Await<void>
 
@@ -132,6 +138,6 @@ /**
    */
-  deleteMany: (
+  deleteMany(
     source: AwaitIterable<Key>,
     options?: AbortOptions & DeleteManyOptionsExtension
-  ) => AwaitIterable<Key>
+  ): AwaitIterable<Key>
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

51156

increased by12.3%

Number of package files

9

increased by12.5%

Lines of code

240

increased by6.67%

Worsened metrics

Number of lines in readme file

40

decreased by-11.11%

No dependency changes