@xylabs/storage 4.13.20 → 4.13.22

package/README.md

@@ -12,13 +12,198 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.19
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## Reference
+
+**@xylabs/storage**
+
+***
+
+## Interfaces
+
+- [ReadonlyKeyValueStore](#interfaces/ReadonlyKeyValueStore)
+- [KeyValueStore](#interfaces/KeyValueStore)
+
+### interfaces
+
+  ### <a id="KeyValueStore"></a>KeyValueStore
+
+[**@xylabs/storage**](#../README)
+
+***
+
+A read/write storage device.
+
+## Extends
+
+- [`ReadonlyKeyValueStore`](#ReadonlyKeyValueStore)\<`TValue`, `TKey`\>
+
+## Type Parameters
+
+### TValue
+
+`TValue`
+
+### TKey
+
+`TKey` = `string`
+
+## Methods
+
+### get()
+
+```ts
+get(key): Promisable<undefined | TValue>;
+```
+
+Returns a promise that resolves to the value for the given key.
+
+### Parameters
+
+#### key
+
+`TKey`
+
+The key to get the value for.
+
+### Returns
+
+`Promisable`\<`undefined` \| `TValue`\>
+
+### Inherited from
+
+[`ReadonlyKeyValueStore`](#ReadonlyKeyValueStore).[`get`](ReadonlyKeyValueStore.md#get)
+
+***
+
+### keys()?
+
+```ts
+optional keys(): Promisable<TKey[]>;
+```
+
+The keys an array of keys.
+
+### Returns
+
+`Promisable`\<`TKey`[]\>
+
+### Inherited from
+
+[`ReadonlyKeyValueStore`](#ReadonlyKeyValueStore).[`keys`](ReadonlyKeyValueStore.md#keys)
+
+***
+
+### clear()?
+
+```ts
+optional clear(): Promisable<void>;
+```
+
+### Returns
+
+`Promisable`\<`void`\>
+
+***
+
+### delete()
+
+```ts
+delete(key): Promisable<void>;
+```
+
+### Parameters
+
+#### key
+
+`TKey`
+
+### Returns
+
+`Promisable`\<`void`\>
+
+***
+
+### set()
+
+```ts
+set(key, value): Promisable<void>;
+```
+
+### Parameters
+
+#### key
+
+`TKey`
+
+#### value
+
+`TValue`
+
+### Returns
+
+`Promisable`\<`void`\>
+
+  ### <a id="ReadonlyKeyValueStore"></a>ReadonlyKeyValueStore
+
+[**@xylabs/storage**](#../README)
+
+***
+
+A readonly storage device.
+
+## Extended by
+
+- [`KeyValueStore`](#KeyValueStore)
+
+## Type Parameters
+
+### TValue
+
+`TValue`
+
+### TKey
+
+`TKey` = `string`
+
+## Methods
+
+### get()
+
+```ts
+get(key): Promisable<undefined | TValue>;
+```
+
+Returns a promise that resolves to the value for the given key.
+
+### Parameters
+
+#### key
+
+`TKey`
+
+The key to get the value for.
+
+### Returns
+
+`Promisable`\<`undefined` \| `TValue`\>
+
+***
+
+### keys()?
+
+```ts
+optional keys(): Promisable<TKey[]>;
+```
+
+The keys an array of keys.
+
+### Returns
+
+`Promisable`\<`TKey`[]\>
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/storage",
-  "version": "4.13.20",
+  "version": "4.13.22",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -42,7 +42,7 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/promise": "^4.13.20"
+    "@xylabs/promise": "^4.13.22"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^7.0.0",