Skip to content

Commit

Permalink
update package.json & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
e-e committed Jan 24, 2018
1 parent 51f43b0 commit b24217e
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 48 deletions.
88 changes: 55 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,98 @@
# base64-img
# base64-img-promise

Convert img to base64, or convert base64 to img

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

## install

```
npm install base64-img --save
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

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

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

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

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

### .base64Sync(filename)
The api same as base64, but it's synchronous

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

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

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

});
base64Img.requestBase64(url, function(err, res, data) {});

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

});
base64Img.requestBase64(url).then(function({ 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

* {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
base64Img.img('data:image/png;base64,...', 'dest', '1', function(err, filepath) {});
base64Img.img('data:image/png;base64,...', 'dest', '1', function(
err,
filepath
) {});

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

});
base64Img
.img('data:image/png;base64,...', 'dest', '1')
.then(function(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
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 10 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
{
"name": "base64-img",
"version": "1.0.3",
"description": "Convert img to base64, or convert base64 to img",
"name": "base64-img-promise",
"version": "1.0.4",
"description":
"Convert img to base64, or convert base64 to img, with the option of using promises",
"main": "base64-img.js",
"scripts": {
"test": "mocha"
},
"repository": {
"type": "git",
"url": "https://github.com/douzi8/base64-img.git"
"url": "https://github.com/e-e/base64-img-promise.git"
},
"keywords": [
"base64",
"img",
"image",
"img base64"
],
"author": "douzi <[email protected]>",
"keywords": ["base64", "img", "image", "img base64", "promise"],
"author": "Eric Ellingson <[email protected]>",
"original_author": "douzi <[email protected]>",
"license": "ISC",
"bugs": {
"url": "https://github.com/douzi8/base64-img/issues"
"url": "https://github.com/e-e/base64-img-promise/issues"
},
"homepage": "https://github.com/douzi8/base64-img",
"homepage": "https://github.com/e-e/base64-img-promise",
"dependencies": {
"ajax-request": "^1.2.0",
"file-system": "^2.1.0"
Expand Down

0 comments on commit b24217e

Please sign in to comment.