1.0.0 • Published 10 years ago
github-avatar v1.0.0
github-avatar
fetch the github avatar for a user
example
simple
var avatar = require('github-avatar');
var fs = require('fs');
avatar('substack').pipe(fs.createWriteStream('substack.jpg'));
using leveldb for caching
var avatar = require('github-avatar');
var fs = require('fs');
var level = require('level');
var img = avatar('substack', { db: level(__dirname + '/cache') });
img.pipe(fs.createWriteStream('substack.jpg'));
methods
var avatar = require('github-avatar')
var img = avatar(username, opts)
Return a readable stream img
of jpeg image data for the github user
username
.
Optionally:
opts.db
- a leveldb handle to use for cachingopts.size
- size in pixels of the image to generateopts.maxAge
- how long in milliseconds to keep an image in the cache
install
With npm do:
npm install github-avatar
license
MIT