blockstore-level - npm Package Compare versions

Comparing version 1.1.4 to 1.1.5

dist/src/index.d.ts

@@ -0,1 +1,16 @@
+/**
+ * @packageDocumentation
+ *
+ * A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
+ *
+ * N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
+ *
+ * @example
+ *
+ * ```js
+ * import { LevelBlockstore } from 'blockstore-level'
+ *
+ * const store = new LevelBlockstore('path/to/store')
+ * ```
+ */
 import { BaseBlockstore } from 'blockstore-core';
@@ -2,0 +17,0 @@ import { Level } from 'level';

dist/src/index.js

@@ -0,1 +1,16 @@
+/**
+ * @packageDocumentation
+ *
+ * A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
+ *
+ * N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
+ *
+ * @example
+ *
+ * ```js
+ * import { LevelBlockstore } from 'blockstore-level'
+ *
+ * const store = new LevelBlockstore('path/to/store')
+ * ```
+ */
 import { BaseBlockstore, Errors } from 'blockstore-core';
@@ -25,3 +40,3 @@ import { Level } from 'level';
             createIfMissing: true,
-            compression: false,
+            compression: false, // same default as go
             ...init
@@ -28,0 +43,0 @@ };

dist/typedoc-urls.json

 {
-  "LevelBlockstore": "https://ipfs.github.io/js-stores/classes/LevelBlockstore.html",
-  ".:LevelBlockstore": "https://ipfs.github.io/js-stores/classes/LevelBlockstore.html",
-  "LevelBlockstoreInit": "https://ipfs.github.io/js-stores/interfaces/LevelBlockstoreInit.html",
-  ".:LevelBlockstoreInit": "https://ipfs.github.io/js-stores/interfaces/LevelBlockstoreInit.html"
+  "LevelBlockstore": "https://ipfs.github.io/js-stores/classes/blockstore_level.LevelBlockstore.html",
+  ".:LevelBlockstore": "https://ipfs.github.io/js-stores/classes/blockstore_level.LevelBlockstore.html",
+  "LevelBlockstoreInit": "https://ipfs.github.io/js-stores/interfaces/blockstore_level.LevelBlockstoreInit.html",
+  ".:LevelBlockstoreInit": "https://ipfs.github.io/js-stores/interfaces/blockstore_level.LevelBlockstoreInit.html"
 }

package.json

 {
   "name": "blockstore-level",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Blockstore implementation with level(up|down) backend",
@@ -40,2 +40,3 @@ "license": "Apache-2.0 OR MIT",
     "parserOptions": {
+      "project": true,
       "sourceType": "module"
@@ -141,4 +142,3 @@ }
     "test:electron-main": "aegir test -t electron-main",
-    "dep-check": "aegir dep-check",
-    "docs": "aegir docs"
+    "dep-check": "aegir dep-check"
   },
@@ -153,3 +153,3 @@ "dependencies": {
   "devDependencies": {
-    "aegir": "^40.0.8",
+    "aegir": "^41.1.9",
     "interface-blockstore-tests": "^6.0.0",
@@ -156,0 +156,0 @@ "ipfs-utils": "^9.0.4",

README.md

@@ -1,3 +0,1 @@
-# blockstore-level <!-- omit in toc -->
-
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
@@ -10,12 +8,18 @@ [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 
-## Table of contents <!-- omit in toc -->
+# About
 
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribute](#contribute)
+A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
 
-## Install
+N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
 
+## Example
+
+```js
+import { LevelBlockstore } from 'blockstore-level'
+
+const store = new LevelBlockstore('path/to/store')
+```
+
+# Install
+
 ```console
@@ -25,3 +29,3 @@ $ npm i blockstore-level
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
@@ -34,7 +38,7 @@ Loading this module through a script tag will make it's exports available as `BlockstoreLevel` in the global namespace.
 
-## API Docs
+# API Docs
 
 - <https://ipfs.github.io/js-stores/modules/blockstore_level.html>
 
-## License
+# License
 
@@ -46,3 +50,3 @@ Licensed under either of
 
-## Contribute
+# Contribute
 
@@ -49,0 +53,0 @@ Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues).

src/index.ts

@@ -0,1 +1,17 @@
+/**
+ * @packageDocumentation
+ *
+ * A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
+ *
+ * N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
+ *
+ * @example
+ *
+ * ```js
+ * import { LevelBlockstore } from 'blockstore-level'
+ *
+ * const store = new LevelBlockstore('path/to/store')
+ * ```
+ */
+
 import { BaseBlockstore, Errors } from 'blockstore-core'
@@ -2,0 +18,0 @@ import { Level } from 'level'

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

121337

increased by1.46%

Lines of code

717

increased by6.7%

Number of lines in readme file

58

increased by7.41%

No dependency changes