https://github.com/webpro/dyson-image

https://github.com/webpro/dyson-image

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/webpro/dyson-image
• Owner: webpro
• Created: 2013-02-13T00:33:14.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2019-10-03T20:14:39.000Z (over 6 years ago)
• Last Synced: 2025-09-22T00:58:02.542Z (7 months ago)
• Language: JavaScript
• Size: 304 KB
• Stars: 6
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# dyson-image

Image proxy and base64 string generator.

Requests are proxied to [http://dummyimage.com](http://dummyimage.com) by default.

Used by [dyson-generators](http://github.com/webpro/dyson-generators) (for base64 image strings) and [dyson](http://github.com/webpro/dyson) (as middleware).

## Installation

Install dyson-image locally by including it in `package.json` as a `devDependency`:

    "devDependencies": {

        "dyson-image": "~0.1"

    }

## Examples

### Image buffer

The `image.request()` method returns a promise which gets resolved with an object containing `mimeType` and `buffer`.

The examples below both create a base64 string representation of a 300x200 image:

    var image = require('dyson-image');

    image.request({

        host: 'http://dummyimage.com',

        path: '/300x200'

    }).then(function(imageObj) {

        var imgBase64 = imageObj.buffer.toString('base64');

        console.log('data:' + imageObj.mimeType + ';base64,' + imgBase64);

    });

    image.request({

        width: 300,

        height: 200

    }).then(function(imageObj) {

        //

    });

### Middleware for Express

    var image = require('dyson-image');

    app.get('/image/*', image.asMiddleware);

A request to `/image/300x200` will be proxied to `http://dummyimage.com/300x200`, and served as image.

## Development & run tests

    git clone git@github.com:webpro/dyson-image.git

    cd dyson-image

    npm install

    npm test