@xylabs/storage - npm Package Compare versions

Comparing version 5.0.83 to 5.0.84

dist/neutral/KeyValueStore.d.ts

@@ -20,6 +20,16 @@ import type { Promisable } from '@xylabs/promise';
 export interface KeyValueStore<TValue, TKey = string> extends ReadonlyKeyValueStore<TValue, TKey> {
+    /** Removes all entries from the store. */
     clear?(): Promisable<void>;
+    /**
+     * Deletes the entry with the given key.
+     * @param key The key of the entry to delete
+     */
     delete(key: TKey): Promisable<void>;
+    /**
+     * Sets a value for the given key, creating or updating the entry.
+     * @param key The key to set
+     * @param value The value to store
+     */
     set(key: TKey, value: TValue): Promisable<void>;
 }
 //# sourceMappingURL=KeyValueStore.d.ts.map

dist/neutral/KeyValueStore.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"KeyValueStore.d.ts","sourceRoot":"","sources":["../../src/KeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM;IAC1D;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C;;OAEG;IACH,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAE,SAAQ,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC/F,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAC1B,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IACnC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;CAChD"}
+{"version":3,"file":"KeyValueStore.d.ts","sourceRoot":"","sources":["../../src/KeyValueStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM;IAC1D;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C;;OAEG;IACH,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAE,SAAQ,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC/F,0CAA0C;IAC1C,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAC1B;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IACnC;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;CAChD"}

package.json

 {
   "name": "@xylabs/storage",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
@@ -45,7 +45,7 @@ "keywords": [
   "dependencies": {
-    "@xylabs/promise": "~5.0.83"
+    "@xylabs/promise": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3"
@@ -52,0 +52,0 @@ },

README.md

@@ -105,2 +105,4 @@ # @xylabs/storage
 
+Removes all entries from the store.
+
 ### Returns
@@ -118,2 +120,4 @@
 
+Deletes the entry with the given key.
+
 ### Parameters
@@ -125,2 +129,4 @@
 
+The key of the entry to delete
+
 ### Returns
@@ -138,2 +144,4 @@
 
+Sets a value for the given key, creating or updating the entry.
+
 ### Parameters
@@ -145,2 +153,4 @@
 
+The key to set
+
 #### value
@@ -150,2 +160,4 @@
 
+The value to store
+
 ### Returns
@@ -152,0 +164,0 @@

No alert changes

Improved metrics

Total package byte prevSize

15618

3.74%

Lines of code

34

41.67%

Number of lines in readme file

257

4.9%

Dependency changes

• Updated

  @xylabs/promise@~5.0.84