Grvtr NPM | npm.io

node-grvtr

============

Small node.js library that generates gravatar url based on an email.

How to use

At first you need to install npm package:

npm install grvtr

Then you can require it in your project and pass an email string to the utility:

var grvtr = require('grvtr');

grvtr.create('john.doe@example.com'); // returns http://gravatar.com/avatar/[HASH]

Gravatar allows you to use several options

grvtr.create('john.doe@example.com', { 
	size: 200,     // 1- 2048px
	default: 'mm', // 'identicon', 'monsterid', 'wavatar', 'retro', 'blank' 
	rating: 'g',   // 'pg', 'r', 'x'
	secure: true,
	forcedefault: true
});
// returns http://gravatar.com/avatar/[HASH]?params

Options according to the gravatar.com documentation:

Size

You may request images anywhere from 1px up to 2048px, however requesting larger sizes may result in pixelation/low-quality images.

Default

Possible values of default image:

404: do not load any image if none is associated with the email hash, instead return an HTTP 404 (File Not Found) response
mm: (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)
identicon: a geometric pattern based on an email hash
monsterid: a generated 'monster' with different colors, faces, etc
wavatar: generated faces with differing features and backgrounds
retro: awesome generated, 8-bit arcade-style pixelated faces
blank: a transparent PNG image

Rating

You can self-rate images indicating if an image is appropriate for a certain audience:

g: suitable for display on all websites with any audience type
pg: may contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence
r: may contain such things as harsh profanity, intense violence, nudity, or hard drug use
x: may contain hardcore sexual imagery or extremely disturbing violence