node-grvtr

KO | EN

gitlite — search

#javascript #python #hacktoberfest #go #golang #machine-learning #rust #java #windows #awesome-list #pytorch #ios #mcp #open-source

(★ 32)

grvtr.js - small node.js gravatar library

node-grvtr Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-grvtr

[![NPM](https://nodei.co/npm/grvtr.png?downloads=true)](https://nodei.co/npm/grvtr/)

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

## How to use

At first you need to install npm package:

```bash
npm install grvtr
```

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

```javascript
var grvtr = require('grvtr');

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

Gravatar allows you to use several options:

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

Also you can pass a callback to ``create`` method (do not forget to add empty object as second parameter if no options required):

```javascript
grvtr.create('john.doe@example.com', {}, function (gravatarUrl) {
	console.log(gravatarUrl); // or do something with the src 'http://gravatar.com/avatar/[HASH]'
});
```
## Options according to [gravatar.com](http://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

![404](http://www.gravatar.com/avatar/00000000000000000000000000000000?d=mm&f=y)
![mm](http://www.gravatar.com/avatar/00000000000000000000000000000000?d=identicon&f=y)
![identicon](http://www.gravatar.com/avatar/00000000000000000000000000000000?d=monsterid&f=y)
![monsterid](http://www.gravatar.com/avatar/00000000000000000000000000000000?d=wavatar&f=y)
![retro](http://www.gravatar.com/avatar/00000000000000000000000000000000?d=retro&f=y)

### 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

### Forcedefault

Use if you want to force the default image to always load - set ``forceDefault`` property to ``true``.

### Secure

If you're displaying Gravatars on a page that is being served over SSL, you can serve gravatars via SSL simply setting this one to ``true``.

## Building and testing

Install the application,

```bash
npm install
```

Make sure, you have latest ``grunt`` installed,

```bash
npm install -g grunt-cli
```

Run build,

```bash
grunt
```

To just run ``jshint``,

```bash
grunt jshint
```

## Contributing

If you have some ideas or found a bug feel free to raise an [issue](https://github.com/voronianski/node-grvtr/issues).

* * *

**MIT Licensed**
(c) 2013 Dmitri Voronianski

node-grvtr

node-grvtr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

node-grvtr

node-grvtr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README