@nimiq/jungle-db - npm Package Compare versions

Comparing version 0.6.3 to 0.7.0

package.json

 {
   "name": "@nimiq/jungle-db",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "main": "dist/lmdb.js",
@@ -31,3 +31,3 @@ "unpkg": "dist/indexeddb.js",
     "levelup": "^2.0.2",
-    "node-lmdb": "^0.5.0"
+    "node-lmdb": "^0.5.1"
   },
@@ -34,0 +34,0 @@ "devDependencies": {

README.md

@@ -31,2 +31,3 @@ # jungle-db [![Build Status](https://travis-ci.org/nimiq-network/jungle-db.svg?branch=master)](https://travis-ci.org/nimiq-network/jungle-db)
 it is most likely that you are using one of the features not supported by Edge.
+One of the unsupported features are binary keys.
 
@@ -124,3 +125,11 @@ Then, create a `JungleDB` instance and potential object stores as follows:
 There is also the possibility to define different backend specific encodings for LevelDB and LMDB using `leveldbValueEncoding` and `lmdbValueEncoding`.
+Possible backend specific encodings are:
+* `JungleDB.JSON_ENCODING` for JSON objects
+* `JungleDB.NUMBER_ENCODING` for numbers
+* `JungleDB.STRING_ENCODING` for strings
+* `JungleDB.BINARY_ENCODING` for binary types
+* `JungleDB.GENERIC_ENCODING` for a generic value (the code automatically determines the encoding and prepends a type byte)
 
+The `createIndex(name, keyPath, options)` method also supports an optional `keyEncoding` option to specify the backend specific encoding of the secondary key.
+
 ### Database Options
@@ -127,0 +136,0 @@ There are options specific to some of the backends. Especially the LMDB backend is highly configurable.

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

Number of lines in readme file

221

increased by4.25%

Worsened metrics

Total package byte prevSize

7163627

decreased by-6.3%

Lines of code

27618

decreased by-7.12%

Dependency changes

• Updatednode-lmdb@^0.5.1