chardet - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

index.js

@@ -123,1 +123,30 @@
 };
+
+// Wrappers for the previous functions to return all encodings
+module.exports.detectAll = function(buffer, opts) {
+  if (typeof opts !== 'object') {
+    opts = {};
+  }
+  opts.returnAllMatches = true;
+  return self.detect(buffer, opts);
+}
+
+module.exports.detectFileAll = function(filepath, opts, cb) {
+  if (typeof opts === 'function') {
+    cb = opts;
+    opts = undefined;
+  }
+  if (typeof opts !== 'object') {
+    opts = {};
+  }
+  opts.returnAllMatches = true;
+  self.detectFile(filepath, opts, cb);
+}
+
+module.exports.detectFileAllSync = function(filepath, opts) {
+  if (typeof opts !== 'object') {
+    opts = {};
+  }
+  opts.returnAllMatches = true;
+  return self.detectFileSync(filepath, opts);
+}

package.json

 {
   "name": "chardet",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "homepage": "https://github.com/runk/node-chardet",
@@ -5,0 +5,0 @@ "description": "Character detector",

README.md

@@ -17,5 +17,6 @@
 
+To return the encoding with the highest confidence:
 ```javascript
 var chardet = require('chardet');
-chardet.detect(new Buffer('hello there!'));
+chardet.detect(Buffer.from('hello there!'));
 // or
@@ -27,2 +28,16 @@ chardet.detectFile('/path/to/file', function(err, encoding) {});
 
+
+To return the full list of possible encodings:
+```javascript
+var chardet = require('chardet');
+chardet.detectAll(Buffer.from('hello there!'));
+// or
+chardet.detectFileAll('/path/to/file', function(err, encoding) {});
+// or
+chardet.detectFileAllSync('/path/to/file');
+
+//Returned value is an array of objects sorted by confidence value in decending order
+//e.g. [{ confidence: 90, name: 'UTF-8'}, {confidence: 20, name: 'windows-1252', lang: 'fr'}]
+```
+
 ## Working with large data sets
@@ -37,12 +52,2 @@
 
-## Returning more detailed results
-
-If you wish to see the full list of possible encodings:
-```javascript
-chardet.detectFile('/path/to/file', { returnAllMatches: true }, function(err, encodings) {
-  //encodings is an array of objects sorted by confidence value in decending order
-  //e.g. [{ confidence: 90, name: 'UTF-8'}, {confidence: 20, name: 'windows-1252', lang: 'fr'}]
-});
-```
-
 ## Supported Encodings:
@@ -49,0 +54,0 @@

No alert changes

Improved metrics

Total package byte prevSize

74825

increased by1.08%

Lines of code

1678

increased by1.57%

Number of lines in readme file

82

increased by6.49%

Worsened metrics

Number of package files

11

decreased by-8.33%

No dependency changes