Gravatar-api NPM

gravatar-api

Node module to build image and profile urls for gravatar.

gravatar-api makes it easy to build gravatar image and profile urls.

To Install

Using node package manager

Example

npm install --save gravatar-api

To Use

Simply add the following require statement to import the module and then call the imageUrl method with the relevant options.

Example

var gravatar = require('gravatar-api');
var options = {
    email: 'test@gmail.com'
}
var avatar = gravatar.imageUrl(options);

You can also specify the size of the image with the following (or any valid gravatar image option)

Example

var options = {
    email: 'test@gmail.com',
    parameters: { "size": "200" }
}
var avatar = gravatar.imageUrl(options);

A valid size is between 1 - 2048.

For more options, see gravatar documentation

Secure Endpoint

You can specify retrieving the secure version of the URL by setting the secure property to true

Example

var options = {
    email: 'test@gmail.com',
    parameters: { "size": "200", "d": "mm" },
    secure: true
}
var avatar = gravatar.imageUrl(options);

Gravatar Profile URLs

You can retrieve a user's gravatar profile url.

see the gravatar docs for more information on what parameters can be used for each type.

Example

var options = {
    email: 'test@gmail.com',
    type: 'json', // Default: json,
                  // Available Types: 'json', 'xml', 'qr', 'php', 'vcf'
    parameters: {'callback': 'doSomething' }, //optional
    secure: true
}
var gravatarProfileUrl = gravatar.getProfileUrl(options);