async-map-like - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

dist/src/version.js

@@ -7,3 +7,3 @@ "use strict";
  */
-exports.VERSION = '0.2.2';
+exports.VERSION = '0.2.3';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "async-map-like",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "ES6 Map TypeScript Interface with Async Support",
@@ -5,0 +5,0 @@ "main": "dist/src/mod.js",

README.md

@@ -23,2 +23,35 @@ # async-map-like
 
+## API Reference
+
+```ts
+/**
+ * ES6 Map like Async API
+ */
+export interface AsyncMapLike<K = any, V = any> {
+
+  size : Promise<number>
+
+  get     (key: K)           : Promise<V | undefined>
+  set     (key: K, value: V) : Promise<void>
+  has     (key: K)           : Promise<boolean>
+  delete  (key: K)           : Promise<void>
+  clear   ()                 : Promise<void>
+
+  entries () : AsyncIterableIterator<[K, V]>
+  keys    () : AsyncIterableIterator<K>
+  values  () : AsyncIterableIterator<V>
+
+  [Symbol.asyncIterator]() : AsyncIterableIterator<[K, V]>
+
+  forEach (
+    callbackfn: (
+      value : V,
+      key   : K,
+      map   : AsyncMapLike<K, V>,
+    ) => void,
+    thisArg?: AsyncMapLike<K, V>,
+  ): Promise<void>
+
+}
+```
 ## History
@@ -25,0 +58,0 @@

src/version.ts

 /**
  * This file was auto generated from scripts/generate-version.sh
  */
-export const VERSION: string = '0.2.2'
+export const VERSION: string = '0.2.3'

No alert changes

Improved metrics

Total package byte prevSize

39896

increased by1.87%

Number of lines in readme file

76

increased by76.74%

No dependency changes