murmurhash-native - npm Package Compare versions

Comparing version 3.2.5 to 3.3.0

HISTORY.md

@@ -0,1 +1,7 @@
+v3.3.0
+
+* TypeScript declarations, documentation and tests
+* bump bluebird to 3.5.3, commander to 2.19.0 and tap to 12.1.0
+* added development dependencies: typescript, @types, typedoc and typedoc plugins
+
 v3.2.5
@@ -2,0 +8,0 @@

package.json

@@ -16,3 +16,3 @@ {
   ],
-  "version": "3.2.5",
+  "version": "3.3.0",
   "license": "MIT",
@@ -28,6 +28,9 @@ "author": "Rafał Michalski <[e-mail]>",
     "install": "node-pre-gyp install --fallback-to-build",
-    "test": "tap -C -Rclassic ./test/test*.js",
+    "test": "tap -C -Rclassic ./test/test*.js ./test/types/test*.js",
+    "test-ts": "tap -C -Rclassic ./test/types/test*.js",
     "test-gc": "tap -Rspec ./test/persistent/test.gc.*.js -gc",
     "bench": "sh bench/bench.all.sh",
-    "rebuild": "node-pre-gyp rebuild"
+    "rebuild": "node-pre-gyp rebuild",
+    "tsc": "tsc -p test/types",
+    "typedoc": "typedoc --tsconfig test/types/tsconfig.json index.d.ts promisify.d.ts incremental.d.ts stream.d.ts"
   },
@@ -41,2 +44,4 @@ "binary": {
   "main": "index.js",
+  "types": "index.d.ts",
+  "typeScriptVersion": "2.0",
   "engines": {
@@ -50,8 +55,14 @@ "node": ">=4"
   "devDependencies": {
-    "bluebird": "^3.5.1",
-    "commander": "^2.17.0",
+    "@types/bluebird": "^3.5.24",
+    "@types/node": "^10.12.8",
+    "bluebird": "^3.5.3",
+    "commander": "^2.19.0",
     "murmurhash3js": "^3.0.1",
     "node-pre-gyp-github": "1.3.1",
-    "tap": "^12.0.1"
+    "tap": "^12.1.0",
+    "typedoc": "^0.13.0",
+    "typedoc-plugin-external-module-name": "^1.1.3",
+    "typedoc-plugin-sourcefile-url": "^1.0.3",
+    "typescript": "^3.1.6"
   }
 }

README.md

@@ -21,2 +21,3 @@ MurmurHash bindings for node
 * prebuilt binaries for most standard system configurations
+* TypeScript declarations ([docs][typescript-docs])
 
@@ -49,2 +50,7 @@ Install:
 
+TypeScript
+----------
+
+`murmurhash-native` is [ready][typescript-docs] for the TypeScript without any external declarations. However this module is node-specific package, if you're going to use it in TypeScript, do not forget to include `@types/node` and enable `es2015` language features in your `tsconfig.json`.
+
 Make a hash:
@@ -98,10 +104,12 @@ ------------
 murmurHash(data, output[, offset[, length]][, callback])
-murmurHash(data{String}, encoding|output_type[, callback])
-murmurHash(data, output_type[, seed][, callback])
-murmurHash(data, seed[, output[, offset[, length]]][, callback])
-murmurHash(data, seed[, output_type][, callback])
+murmurHash(data{string}, encoding|output_type[, seed][, callback])
+murmurHash(data{Buffer}, output_type[, seed][, callback])
+murmurHash(data, seed[, callback])
+murmurHash(data, seed, output[, offset[, length]][, callback])
+murmurHash(data, seed, output_type[, callback])
 murmurHash(data, encoding, output_type[, callback])
-murmurHash(data{String}, encoding, output[, offset[, length]][, callback])
-murmurHash(data{String}, encoding, seed[, output[, offset[, length]]][, callback])
-murmurHash(data{String}, encoding, seed[, output_type][, callback])
+murmurHash(data{string}, encoding, output[, offset[, length]][, callback])
+murmurHash(data{string}, encoding, seed[, callback])
+murmurHash(data{string}, encoding, seed, output[, offset[, length]][, callback])
+murmurHash(data{string}, encoding, seed, output_type[, callback])
 ```
@@ -315,2 +323,3 @@
 [releases]: https://github.com/royaltm/node-murmurhash-native/releases
-[node-gyp-install]: https://github.com/nodejs/node-gyp#installation
+[node-gyp-install]: https://github.com/nodejs/node-gyp#installation
+[typescript-docs]: http://royaltm.github.io/node-murmurhash-native/globals.html

stream.js

@@ -66,3 +66,3 @@ "use strict";
   } else {
-    throw new TypeError("Must give algorithm string or MurmurHash instance");
+    throw new TypeError("Must give algorithm string, a serialized state or a MurmurHash instance");
   }
@@ -69,0 +69,0 @@

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

Major refactor

Supply chain risk

Package 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

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

165583

increased by19.01%

Number of package files

34

increased by13.33%

Lines of code

758

increased by238.39%

Number of lines in readme file

321

increased by2.88%

Worsened metrics

Dev dependency count

11

increased by120%

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes