@xylabs/storage - npm Package Compare versions

Comparing version 5.0.84 to 5.0.86

package.json

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

README.md

@@ -18,2 +18,4 @@ # @xylabs/storage
 
+
+
 ## Reference
@@ -27,4 +29,6 @@
 
-- [ReadonlyKeyValueStore](#interfaces/ReadonlyKeyValueStore)
-- [KeyValueStore](#interfaces/KeyValueStore)
+| Interface | Description |
+| ------ | ------ |
+| [ReadonlyKeyValueStore](#interfaces/ReadonlyKeyValueStore) | A readonly storage device. |
+| [KeyValueStore](#interfaces/KeyValueStore) | A read/write storage device. |
 
@@ -47,10 +51,7 @@ ### interfaces
 
-### TValue
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TValue` | - |
+| `TKey` | `string` |
 
-`TValue`
-
-### TKey
-
-`TKey` = `string`
-
 ## Methods
@@ -61,3 +62,3 @@
 ```ts
-get(key): Promisable<TValue | undefined>;
+get(key: TKey): Promisable<TValue | undefined>;
 ```
@@ -69,8 +70,6 @@
 
-#### key
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to get the value for. |
 
-`TKey`
-
-The key to get the value for.
-
 ### Returns
@@ -121,3 +120,3 @@
 ```ts
-delete(key): Promisable<void>;
+delete(key: TKey): Promisable<void>;
 ```
@@ -129,8 +128,6 @@
 
-#### key
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key of the entry to delete |
 
-`TKey`
-
-The key of the entry to delete
-
 ### Returns
@@ -145,3 +142,3 @@
 ```ts
-set(key, value): Promisable<void>;
+set(key: TKey, value: TValue): Promisable<void>;
 ```
@@ -153,14 +150,7 @@
 
-#### key
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to set |
+| `value` | `TValue` | The value to store |
 
-`TKey`
-
-The key to set
-
-#### value
-
-`TValue`
-
-The value to store
-
 ### Returns
@@ -184,10 +174,7 @@
 
-### TValue
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TValue` | - |
+| `TKey` | `string` |
 
-`TValue`
-
-### TKey
-
-`TKey` = `string`
-
 ## Methods
@@ -198,3 +185,3 @@
 ```ts
-get(key): Promisable<TValue | undefined>;
+get(key: TKey): Promisable<TValue | undefined>;
 ```
@@ -206,8 +193,6 @@
 
-#### key
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `TKey` | The key to get the value for. |
 
-`TKey`
-
-The key to get the value for.
-
 ### Returns
@@ -214,0 +199,0 @@

No alert changes

Improved metrics

Total package byte prevSize

16120

3.21%

Worsened metrics

Number of lines in readme file

242

-5.84%

Dependency changes

• Updated

  @xylabs/promise@~5.0.86