snappy - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

@@ -5,3 +5,3 @@ {
   "description": "Nodejs bindings to Google's Snappy compression library",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "homepage": "https://github.com/kesla/node-snappy",
@@ -8,0 +8,0 @@ "repository": {

Readme.md

@@ -16,20 +16,46 @@ # Node-snappy [![Build Status](https://secure.travis-ci.org/kesla/node-snappy.png)](http://travis-ci.org/kesla/node-snappy)
 ### String
-    snappy = require('./snappy');
-    // Use synchronous version
-    var compressed= snappy.compressSync('string to compress');
-    snappy.decompressSync(compressed, snappy.parsers.string);
-    // result will be string instead of Buffer
-      console.log(result);
-    }
+```js
+  var snappy = require('./snappy');
+  // Use synchronous version
+  var compressed = snappy.compressSync('string to compress');
+  var result = snappy.decompressSync(compressed, snappy.parsers.string);
+  // result will be string instead of Buffer
+  console.log(result);
+```
 
 ### JSON
-    snappy = require('./snappy');
-    // Snappy automatically convert json to a string
-    snappy.compress({"foo": "bar"}, function(err, compressed){
-      snappy.decompress(compressed, snappy.parsers.json, function(err, result){
-      // result will be json instead of Buffer
-        console.log(result["foo"]);
-      }
+```js
+  var snappy = require('./snappy');
+  // Snappy automatically convert json to a string
+  snappy.compress({"foo": "bar"}, function(err, compressed){
+    snappy.decompress(compressed, snappy.parsers.json, function(err, result){
+    // result will be json instead of Buffer
+      console.log(result["foo"]);
     }
+  }
+```
 
+## API
+### snappy.compress(input, cb)
+
+Compress `input`, which can be a Buffer, String or arbitrary JavaScript object and call `cb` with `err` and `compressed`.
+
+### snappy.compressSync(input)
+
+Compress `input`, which can be a Buffer, String or arbitrary JavaScript object and return `compressed`. Throws if an error occurs.
+
+### snappy.decompress(compressed, cb[, parse])
+
+Decompress `compressed` using `parse` as parser (defaults to `raw`) and call `cb` with `err` and `decompressed`.
+
+### snappy.decompressSync(str, parse)
+
+Decompress `compressed` using `parse` as parser (defaults to `raw`) and return `decompressed`. Throws if an error occurs.
+
+## Parsers
+
+* json
+* string
+* raw
+
 # License
@@ -36,0 +62,0 @@ Copyright (c) 2011 David Björklund

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

Native code

Supply chain risk

Contains native code which could be a vector to obscure malicious code, and generally decrease the likelihood of reproducible or reliable installs.

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

5

decreased by-16.67%

Lines of code

565

increased by1.07%

Number of lines in readme file

80

increased by48.15%

Worsened metrics

Total package byte prevSize

1532610

decreased by-21.13%

Number of package files

54

decreased by-15.62%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes