@xylabs/storage 5.0.95 → 5.0.96

package/README.md

@@ -1,38 +1,52 @@
 # @xylabs/storage
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
-## Reference
+```sh
+yarn add {{name}}
+```
 
-**@xylabs/storage**
+Using pnpm:
 
-***
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
+
+
+## License
 
-## Interfaces
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-| Interface | Description |
-| ------ | ------ |
-| [ReadonlyKeyValueStore](#interfaces/ReadonlyKeyValueStore) | A readonly storage device. |
-| [KeyValueStore](#interfaces/KeyValueStore) | A read/write storage device. |
+## Reference
+
+### packages
+
+  ### storage
 
-### interfaces
+    ### .temp-typedoc
 
-  ### <a id="KeyValueStore"></a>KeyValueStore
+      ### interfaces
+
+        ### <a id="KeyValueStore"></a>KeyValueStore
 
 [**@xylabs/storage**](#../README)
 
@@ -46,26 +60,31 @@ A read/write storage device.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TValue` | - |
-| `TKey` | `string` |
+### TValue
+
+`TValue`
+
+### TKey
+
+`TKey` = `string`
 
 ## Methods
 
 ### get()
 
 ```ts
-get(key: TKey): Promisable<TValue | undefined>;
+get(key): Promisable<TValue | undefined>;
 ```
 
 Returns a promise that resolves to the value for the given key.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to get the value for. |
+#### key
+
+`TKey`
+
+The key to get the value for.
 
 ### Returns
 
@@ -112,16 +131,18 @@ Removes all entries from the store.
 ### delete()
 
 ```ts
-delete(key: TKey): Promisable<void>;
+delete(key): Promisable<void>;
 ```
 
 Deletes the entry with the given key.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key of the entry to delete |
+#### key
+
+`TKey`
+
+The key of the entry to delete
 
 ### Returns
 
@@ -132,23 +153,30 @@ Deletes the entry with the given key.
 ### set()
 
 ```ts
-set(key: TKey, value: TValue): Promisable<void>;
+set(key, value): Promisable<void>;
 ```
 
 Sets a value for the given key, creating or updating the entry.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to set |
-| `value` | `TValue` | The value to store |
+#### key
+
+`TKey`
+
+The key to set
+
+#### value
+
+`TValue`
+
+The value to store
 
 ### Returns
 
 `Promisable`\<`void`\>
 
-  ### <a id="ReadonlyKeyValueStore"></a>ReadonlyKeyValueStore
+        ### <a id="ReadonlyKeyValueStore"></a>ReadonlyKeyValueStore
 
 [**@xylabs/storage**](#../README)
 
@@ -162,26 +190,31 @@ A readonly storage device.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TValue` | - |
-| `TKey` | `string` |
+### TValue
+
+`TValue`
+
+### TKey
+
+`TKey` = `string`
 
 ## Methods
 
 ### get()
 
 ```ts
-get(key: TKey): Promisable<TValue | undefined>;
+get(key): Promisable<TValue | undefined>;
 ```
 
 Returns a promise that resolves to the value for the given key.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to get the value for. |
+#### key
+
+`TKey`
+
+The key to get the value for.
 
 ### Returns
 
@@ -202,41 +235,7 @@ The keys an array of keys.
 `Promisable`\<`TKey`[]\>
 
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
-
-## License
-
-> See the [LICENSE](LICENSE) file for license details
-
-## Credits
-
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
-
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
-
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/storage.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/storage
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/storage
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/storage
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/storage/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/storage
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/storage
-[socket-link]: https://socket.dev/npm/package/@xylabs/storage
+[license-badge]: https://img.shields.io/npm/l/@xylabs/storage.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/storage",
-  "version": "5.0.95",
+  "version": "5.0.96",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -29,12 +29,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -43,12 +41,11 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/promise": "~5.0.95"
+    "@xylabs/promise": "~5.0.96"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-common": "~7.8.4",
-    "@xylabs/ts-scripts-pnpm": "~7.8.4",
-    "@xylabs/tsconfig": "~7.8.4",
+    "@xylabs/toolchain": "~7.10.4",
+    "@xylabs/tsconfig": "~7.10.4",
     "typescript": "^5"
   },
   "engines": {