Code Monkey home page Code Monkey logo

github-avatar's Introduction

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 caching
  • opts.size - size in pixels of the image to generate
  • opts.maxAge - how long in milliseconds to keep an image in the cache

install

With npm do:

npm install github-avatar

license

MIT

github-avatar's People

Contributors

leecrossley avatar

Watchers

James Cloos avatar Nikolay Karadzhov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.