@xn-02f/gravatar
Version:
A library to generate gravatar image url.
49 lines (34 loc) • 3.63 kB
Markdown
# Gravatar
[](https://github.com/xn-02f/gravatar/actions)
[](https://www.npmjs.com/package/@xn-02f/gravatar)
[](https://github.com/xn-02f/gravatar/blob/main/LICENSE)
> 🖼 `Gravatar` is a node library to generate gravatar image url.
## Install
Via npm :
```bash
npm i @xn-02f/gravatar
```
> [!NOTE]
> This library was moved to ESM from `v2`.
>
> If ESM doesn't work well with your node version, switch to the `1.x` version for CJS compatibility.
## Usage
```javascript
const gravatar = require('@xn-02f/gravatar')
const email = 'i@xn--02f.com'
const options = {size: '80', default: '404'}
gravatar(email, options)
```
| Parameter | Description |
| --- | --- |
| email | `string`<br>The gravatar email url. |
| options | `object`<br>Query string options. Like: `size`, `default`, `rating`, `forcedefault` and [others](https://en.gravatar.com/site/implement/images/). |
### About options parameter
| Property | Alias | Default | Description |
| --- | --- | --- | --- |
| size | `s` | 80 | Request a specific image size, which will be dynamically delivered from Gravatar and passing a single pixel dimension.<br>(since the images are square) |
|default | `d` |  | Set default image when an email address has no matching Gravatar image.<br>Gravatar has a number of built in options:<br>`404` do not load any image if none is associated with the email hash, instead return an HTTP 404 (File Not Found) response.<br> `mp` <br> `identicon` <br> `monsterid` <br> `wavatar` <br> `retro` <br> `robohash` <br> `blank`  |
| forcedefault<br>(Unrecommend) | `f` | (null) | If for some reason you wanted to force the default image to always load, you can do that by using the parameter, and setting its value to `y`.<br> Before: <br> After:  |
| rating | `r` | g | This property allows users to self-rate their images so that they can indicate if an image is appropriate for a certain audience.<br> you can specify one of the following ratings to request images up to and including that rating:<br> `g`: suitable for display on all websites with any audience type.<br> `pg`: may contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence.<br> `r`: may contain such things as harsh profanity, intense violence, nudity, or hard drug use.<br> `x`: may contain hardcore sexual imagery or extremely disturbing violence. |
### License
> [MIT](https://github.com/xn-02f/gravatar/blob/main/LICENSE)