NeoFaker.Gravatar (neo_faker v0.8.0)

View Source

Provides functions for generating random Gravatar URLs.

This module is based on the Gravatar API documentation.

Summary

Types

email()

Email address.

Functions

display(email \\ nil, opts \\ [])

Generates a Gravatar URL from an email address.

Types

email()

(since 0.3.1) 
@type email() :: String.t() | nil

Email address.

Functions

display(email \\ nil, opts \\ [])

(since 0.3.1) 
@spec display(email(), Keyword.t()) :: String.t()

Generates a Gravatar URL from an email address.

The generated URL includes query parameters for image size and fallback options. If no email address is provided, a random one is used.

Options

The accepted options are:

  • :size - Defines the image size.
  • :fallback - Specifies the default fallback image.

The values for :size can be:

  • nil - Uses 80px (default).
  • integer - The image size in pixels (valid range: 1 to 2048).

The values for :fallback can be:

  • nil - Generates an "identicon" image (default).
  • :identicon - Generates an "identicon" image.
  • :monsterid - Generates a "monsterid" image.
  • :wavatar - Generates a "wavatar" image.
  • :robohash - Generates a "robohash" image.

Examples 

iex> NeoFaker.Gravatar.display()
"https://gravatar.com/avatar/<hashed_email>?d=identicon&s=80"

iex> NeoFaker.Gravatar.display("john.doe@example.com")
"https://gravatar.com/avatar/<hashed_email>?d=identicon&s=80"

iex> NeoFaker.Gravatar.display("john.doe@example.com", size: 100)
"https://gravatar.com/avatar/<hashed_email>?d=identicon&s=100"

iex> NeoFaker.Gravatar.display("john.doe@example.com", fallback: :monsterid)
"https://gravatar.com/avatar/<hashed_email>?d=monsterid&s=80"