NeoFaker.Internet (neo_faker v0.13.0)

View Source

Functions for generating internet-related data.

This module provides utilities to generate random internet-related information, such as email addresses, domain names, URLs, IP addresses, and MAC addresses.

Summary

Functions

domain_name(opts \\ [])

Generates a random domain name.

email(opts \\ [])

Generates a random email address.

ipv4()

Generates a random IPv4 address.

ipv6(opts \\ [])

Generates a random IPv6 address.

mac_address(opts \\ [])

Generates a random MAC address.

tld(opts \\ [])

Generates a random top-level domain (TLD).

username(opts \\ [])

Generates a random username.

Functions

domain_name(opts \\ [])

(since 0.13.0) 
@spec domain_name(keyword()) :: String.t()

Generates a random domain name.

Returns a random domain name string based on the specified options.

Options

The accepted options are:

  • :word_count - Specifies the number of words to include in the domain name. Defaults to 1.
  • :type - Specifies the type of domain name to generate.

The values for :type can be:

  • :random - Generates a random domain name using a random word (default).
  • :popular - Selects a domain name from a list of popular domains, with the specific category defined by the :popular_type option. For this option, the output will be a full domain name like "gmail.com".
  • :custom - Uses a custom domain name provided by the user via the :domain_name option. If not provided, defaults to "example.com".

If :type is set to :popular, the :popular_type option can be used to specify the category of popular domains to select from. The values for :popular_type can be:

  • :all - Selects from all popular domains (default).
  • :ecommerce - Selects from popular e-commerce domains.
  • :email - Selects from popular email service domains.
  • :search - Selects from popular search engine domains.
  • :social - Selects from popular social media domains.

Examples

iex> NeoFaker.Internet.domain_name()
"example"

iex> NeoFaker.Internet.domain_name(word_count: 3)
"alpha-beta-gamma"

iex> NeoFaker.Internet.domain_name(type: :popular, popular_type: :email)
"gmail.com"

iex> NeoFaker.Internet.domain_name(type: :custom, domain_name: "elixir-lang.org")
"elixir-lang.org"

email(opts \\ [])

(since 0.13.0) 
@spec email(Keyword.t()) :: String.t()

Generates a random email address.

Returns a random email address string based on the specified options.

Options

Username Options

The accepted options for username generation are:

  • :username_word_count - Specifies the number of words to include in the username. Defaults to 2.
  • :joiner - Defines the joiner to use between words in the username.
  • :username_type - Specifies the type of words to use in the username.
  • :number - A boolean indicating whether to append a random number to the username. Defaults to false, if set to true, a number will be appended between 1 and 1000, for define a custom range, use the :number_range option.
  • :number_range - Defines the range of numbers to choose from when appending a number. Defaults to 1..1000.

The values for :joiner can be:

  • :all - Uses any of the joiners (default).
  • :dot - Uses a dot (.) as the joiner.
  • :underscore - Uses an underscore (_) as the joiner.
  • :dash - Uses a dash (-) as the joiner.

The values for :username_type can be:

  • :person - Uses random first or last names for the username (default).
  • :word - Uses random words for the username.

Domain Name Options

The accepted options for domain name generation are:

  • :domain_name_word_count - Specifies the number of words to include in the domain name. Defaults to 1.
  • :domain_type - Specifies the type of domain name to generate.
  • :popular_type - When :domain_type is set to :popular, this option defines the category of popular domains to select from. Defaults to :all.
  • :domain_name - When :domain_type is set to :custom, this option allows the user to provide a custom domain name. If not provided, defaults to "example.com".

The values for :domain_type can be:

  • :random - Generates a random domain name using a random word (default).
  • :popular - Selects a domain name from a list of popular domains, with the specific category defined by the :popular_type option. For this option, the output will be a full domain name like "gmail.com".
  • :custom - Uses a custom domain name provided by the user via the :domain_name option. If not provided, defaults to "example.com".

If :domain_type is set to :popular, the :popular_type option can be used to specify the category of popular domains to select from. The values for :popular_type can be:

  • :all - Selects from all popular domains (default).
  • :ecommerce - Selects from popular e-commerce domains.
  • :email - Selects from popular email service domains.
  • :search - Selects from popular search engine domains.
  • :social - Selects from popular social media domains.

TLD Options

The accepted options for TLD generation are:

  • :tld_type - Specifies the type of TLD to generate.

The values for :tld_type can be:

  • :all_except_safe - Returns a TLD from all types except safe TLDs (default).
  • :all - Returns a TLD from all available types, including safe TLDs.
  • :safe - Returns a safe TLD, e.g. .example.
  • :generic - Returns a generic TLD, e.g. .com.
  • :sponsored - Returns a sponsored TLD, e.g. .edu.
  • :country_code - Returns a country code TLD, e.g. .id.

Examples

iex> NeoFaker.Internet.email()
"josé@example.com"

iex> NeoFaker.Internet.email(word_count: 3, joiner: :dot, number: true)
"abigail.bethany.crawford_202"

iex> NeoFaker.Internet.email(domain_type: :popular, popular_type: :email)
"jane.doe@gmail.com"

iex> NeoFaker.Internet.email(domain_type: :custom, domain_name: "elixir-lang.org")
"josé@elixir-lang.org"

iex> NeoFaker.Internet.email(tld_type: :country_code, dot: false)
"josé@example.id"

ipv4()

(since 0.13.0) 
@spec ipv4() :: String.t()

Generates a random IPv4 address.

Returns a random IPv4 address string.

Examples

iex> NeoFaker.Internet.ipv4()
"183.235.34.108"

ipv6(opts \\ [])

(since 0.13.0) 
@spec ipv6(Keyword.t()) :: String.t()

Generates a random IPv6 address.

Returns a random IPv6 address string.

Options

The accepted options are:

  • :uppercase - A boolean indicating whether to return the address in uppercase. Defaults to true.

Examples

iex> NeoFaker.Internet.ipv6()
"E0E6:7E24:EC6E:E44C:FC69:9C25:CD85:CE08"

iex> NeoFaker.Internet.ipv6(uppercase: false)
"e0e6:7e24:ec6e:e44c:fc69:9c25:cd85:ce08"

mac_address(opts \\ [])

(since 0.13.0) 
@spec mac_address(Keyword.t()) :: String.t()

Generates a random MAC address.

Returns a random MAC address string.

Options

The accepted options are:

  • :uppercase - A boolean indicating whether to return the MAC address in uppercase. Defaults to true.

Examples

iex> NeoFaker.Internet.mac_address()
"74:4E:44:B0:D0:93"

iex> NeoFaker.Internet.mac_address(uppercase: false)
"74:4e:44:b0:d0:93"

tld(opts \\ [])

(since 0.13.0) 
@spec tld(Keyword.t()) :: String.t()

Generates a random top-level domain (TLD).

Returns a random TLD string.

Options

The accepted options are:

  • :dot - A boolean indicating whether to include a leading dot in the TLD. Defaults to true.
  • :type - Specifies the type of TLD to generate.

The values for :type can be:

  • :all_except_safe - Returns a TLD from all types except safe TLDs. This is the default.
  • :all - Returns a TLD from all available types, including safe TLDs.
  • :safe - Returns a safe TLD, e.g. .example.
  • :generic - Returns a generic TLD, e.g. .com.
  • :sponsored - Returns a sponsored TLD, e.g. .edu.
  • :country_code - Returns a country code TLD, e.g. .id.

Examples

iex> NeoFaker.Internet.tld()
".com"

iex> NeoFaker.Internet.tld(dot: false)
"org"

iex> NeoFaker.Internet.tld(type: :safe)
".example"

iex> NeoFaker.Internet.tld(type: :country_code)
".id"

username(opts \\ [])

(since 0.13.0) 
@spec username(Keyword.t()) :: String.t()

Generates a random username.

Returns a random username string.

Options

The accepted options are:

  • :word_count - Specifies the number of words to include in the username. Defaults to 2.
  • :joiner - Defines the joiner to use between words in the username.
  • :username_type - Specifies the type of words to use in the username.
  • :number - A boolean indicating whether to append a random number to the username. Defaults to false.
  • :number_range - Defines the range of numbers to choose from when appending a number. Defaults to 1..1000.

The values for :joiner can be:

  • :all - Uses any of the joiners (default).
  • :dot - Uses a dot (.) as the joiner.
  • :underscore - Uses an underscore (_) as the joiner.
  • :dash - Uses a dash (-) as the joiner.

The values for :username_type can be:

  • :person - Uses random first or last names for the username (default).
  • :word - Uses random words for the username.

Examples

iex> NeoFaker.Internet.username()
"josé_valim"

iex> NeoFaker.Internet.username(word_count: 3, joiner: :dot)
"abigail.bethany.crawford"

iex> NeoFaker.Internet.username(username_type: :word, number: true, number_range: 1..2025)
"elixir_alchemist_2012"