base64-img-promise/README.md

Convert img to base64, or convert base64 to img, with the option of using promises

# base64-img-promise

Convert img to base64, or convert base64 to img

```js
var base64Img = require('base64-img-promise');
```

## install

```
npm install base64-img-promise --save
```

## test

```
mocha
```

## API

Note: All methods which take a callback, if omitted, will return a promise

### .base64(filename[, callback])

Convert image file to image base64 data

* {string} `filename` required  
  The image path
* {function} `callback(err, data)` optional  
  Callback with image base64 data

```js
/* promise */
base64Img.base64('path/demo.png').then(function(data) {});

/* callback */
base64Img.base64('path/demo.png', function(err, data) {});
```

### .base64Sync(filename)

The api same as base64, but it's synchronous

```js
var data = base64Img.base64Sync('path/demo.png');
```

### .requestBase64(url[, callback])

* {string} `url` required
* {function} `callback(err, res, body)` optional  
  Callback with http request

```js
/* promise */
var url = 'http://../demo.png';
base64Img.requestBase64(url).then(function({ res, data }) {});

var url = 'http://../demo.png';
base64Img.requestBase64(url, function(err, res, data) {});
```

### .img(data, destpath, name[, callback])

Convert image base64 data to image

* {string} `data` required  
  Image base64 data
* {string} `destpath` required  
  Dest path, if the destpath is root, pass empty string
* {string} `name` required  
  The image's filename
* {function} `callback(err, filepath)` optional

```js
/* promise */
base64Img
  .img('data:image/png;base64,...', 'dest', '1')
  .then(function(filepath) {});

base64Img.img('data:image/png;base64,...', 'dest', '1', function(
  err,
  filepath
) {});
```

### .imgSync(data, destpath, name)

The api same as img, but it's synchronous

```js
var filepath = base64Img.imgSync('data:image/png;base64,...', '', '2');
```

---

This is a fork of https://github.com/douzi8/base64-img