interface-datastore
Advanced tools
interface-datastore - npm Package Compare versions
Comparing version 6.0.1 to 6.0.2
| export { | ||
| Key | ||
| } from './key'; | ||
| } from './key.js'; |
| { | ||
| "name": "interface-datastore", | ||
| "version": "6.0.1", | ||
| "version": "6.0.2", | ||
| "description": "datastore interface", | ||
| "leadMaintainer": "Alex Potsides <alex.potsides@protocol.ai>", | ||
| "types": "types/src/index.d.ts", | ||
| "typesVersions": { | ||
| "*": { | ||
| "*": [ | ||
| "types/src/*" | ||
| ], | ||
| "types/*": [ | ||
| "types/src/*" | ||
| ], | ||
| "types/src/*": [ | ||
| "types/src/*" | ||
| ] | ||
| } | ||
| }, | ||
| "exports": { | ||
@@ -28,3 +41,4 @@ ".": { | ||
| "dep-check": "aegir dep-check -i rimraf", | ||
| "clean": "rimraf dist types" | ||
| "clean": "rimraf dist types", | ||
| "test": "aegir test" | ||
| }, | ||
@@ -48,3 +62,4 @@ "repository": { | ||
| "aegir": "^35.0.0", | ||
| "rimraf": "^3.0.2" | ||
| "rimraf": "^3.0.2", | ||
| "util": "^0.12.4" | ||
| }, | ||
@@ -51,0 +66,0 @@ "dependencies": { |
@@ -18,6 +18,3 @@ # interface-datastore <!-- omit in toc --> | ||
| - [Implementations](#implementations) | ||
| - [Adapter](#adapter) | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [Wrapping Stores](#wrapping-stores) | ||
| - [Test suite](#test-suite) | ||
@@ -34,5 +31,6 @@ - [Aborting requests](#aborting-requests) | ||
| - Backed Implementations | ||
| - Memory: [`src/memory`](src/memory.js) | ||
| - Memory: [`datastore-core/memory`](https://github.com/ipfs/js-datastore-core/tree/master/src/memory.js) | ||
| - level: [`datastore-level`](https://github.com/ipfs/js-datastore-level) (supports any levelup compatible backend) | ||
| - File System: [`datstore-fs`](https://github.com/ipfs/js-datastore-fs) | ||
| - S3: [`datstore-s3`](https://github.com/ipfs/js-datastore-s3) | ||
| - Wrapper Implementations | ||
@@ -58,28 +56,2 @@ - Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-datastore-core/tree/master/src/mount.js) | ||
| ## Adapter | ||
| An adapter is made available to make implementing your own datastore easier: | ||
| ```javascript | ||
| const { Adapter } from 'interface-datastore') | ||
| class MyDatastore extends Adapter { | ||
| constructor () { | ||
| super() | ||
| } | ||
| async put (key, val) { | ||
| // your implementation here | ||
| } | ||
| async get (key) { | ||
| // your implementation here | ||
| } | ||
| // etc... | ||
| } | ||
| ``` | ||
| See the [MemoryDatastore](./src/memory.js) for an example of how it is used. | ||
| ## Install | ||
@@ -91,21 +63,11 @@ | ||
| ## Usage | ||
| ### Test suite | ||
| ### Wrapping Stores | ||
| Available via the [`interface-datastore-tests`](https://npmjs.com/package/interface-datastore-tests) module | ||
| ```js | ||
| const MemoryStore from 'interface-datastore').MemoryDatastore | ||
| const MountStore from 'datastore-core').MountDatastore | ||
| const Key from 'interface-datastore').Key | ||
| import { interfaceDatastoreTests } from 'interface-datastore-tests' | ||
| const store = new MountStore({ prefix: new Key('/a'), datastore: new MemoryStore() }) | ||
| ``` | ||
| ### Test suite | ||
| Available under [`src/tests.js`](src/tests.js) | ||
| ```js | ||
| describe('mystore', () => { | ||
| require('interface-datastore/src/tests')({ | ||
| interfaceDatastoreTests({ | ||
| async setup () { | ||
@@ -186,2 +148,2 @@ return instanceOfMyStore | ||
| [Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number | ||
| [Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean | ||
| [Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Number of medium supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-0.72%
44445
- Dev dependency count
- increased by50%
3
- Number of lines in readme file
- decreased by-20.33%
145