node-base64-image - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

index.js

@@ -17,17 +17,30 @@ 'use strict';
 
-  request({url: url, encoding: null}, function (err, res, body) {
-    if (err) { return callback(err); }
+  var encoder = function (body, options) {
+    var image;
 
-    if (body && res.statusCode === 200) {
-      var image;
+    if (options && options.string === true) {
+      image = body.toString('base64');
+      return callback(null, image);
+    } else {
+      image = new Buffer(body, 'base64');
+      return callback(null, image);
+    }
+  };
 
-      if (options && options.string === true) {
-        image = body.toString('base64');
-        return callback(null, image);
-      } else {
-        image = new Buffer(body, 'base64');
-        return callback(null, image);
+  if (options && options.localFile === true) {
+    fs.readFile(url, function (err, data) {
+      if (err) { return callback(err); }
+
+      return encoder(data, options);
+    });
+  } else {
+    request({url: url, encoding: null}, function (err, res, body) {
+      if (err) { return callback(err); }
+
+      if (body && res.statusCode === 200) {
+        return encoder(body, options);
       }
-    }
-  });
+    });
+  }
+
 };
@@ -34,0 +47,0 @@

package.json

 {
   "name": "node-base64-image",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Download images from remote URLs and encode/decode them to base64",
@@ -27,3 +27,3 @@ "main": "index.js",
   "author": "Riyadh Al Nur <[e-mail]> (http://blog.verticalaxisbd.com)",
-  "license": "GPLv3",
+  "license": "MIT",
   "dependencies": {
@@ -36,2 +36,2 @@ "request": "^2.51.x"
   }
-}
+}

README.md

@@ -6,3 +6,3 @@ [![Build Status](https://travis-ci.org/riyadhalnur/node-base64-image.svg?branch=master)](https://travis-ci.org/riyadhalnur/node-base64-image)
 
-Download images from remote URLs and encode/decode them to base64
+Download images from remote URLs or use local images and encode/decode them to base64
 
@@ -30,5 +30,18 @@ To install
 
+#### Encode a local image  
+```  
+var path = __dirname + '/../test.jpg',
+          options = {localFile: true, string: true};
+
+base64.base64encode(path, function (err, image) {  
+    if (err) { console.log(err); }  
+    console.log(image);  
+});  
+```
+
+
 ##### Parameters  
 url (string) - the url of the image to be downloaded and encoded.
 options (object) - if string is passed is with 'true', the image returned will be a base64 string. Otherwise, the base64 buffer is returned.  
+                 if localFile is passed is with 'true', a local image instead of a remote one will be used  
 callback (function) - the callback will contain the err object and the encoded image object.  
@@ -38,6 +51,6 @@
 ```  
-var options = {filename: 'test'}; 
-var imageData = new Buffer('/9j/4AAQSkZJRgABAQAAAQABAAD...', 'base64'); 
+var options = {filename: 'test'};
+var imageData = new Buffer('/9j/4AAQSkZJRgABAQAAAQABAAD...', 'base64');
 
-base64.base64decode(imageData, options, function (err, saved) {
+base64.base64decoder(imageData, options, function (err, saved) {
     if (err) { console.log(err); }  
@@ -48,9 +61,9 @@ console.log(saved);
 
-##### Paramaters  
+##### Parameters  
 imageData (buffer) - the base64 image buffer.  
 options (object) - contains the 'filename' property; this will be the written image file.  
-callback (function) - the callback will contain the err object and the 'successful save' string. 
+callback (function) - the callback will contain the err object and the 'successful save' string.
 
 ### License  
-This library is licensed under the GPL v3.0 license.  
+This library is licensed under the MIT license.  
 
@@ -57,0 +70,0 @@ ### Issues

Fixed alerts

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

504105

increased by55.31%

Number of package files

8

increased by14.29%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by42.86%

Lines of code

1232

increased by2.67%

Number of lines in readme file

70

increased by22.81%

No dependency changes