NeoFaker.Date (neo_faker v0.10.0)
View SourceFunctions for generating random dates.
This module provides utilities to generate random dates, including dates within a specific range, birthdays, and more.
Summary
Functions
Generates a random date.
Generates a random date between two dates.
Generates a random birthday.
Functions
Generates a random date.
Returns a date within the default range of 365 days before and 365 days after today.
Options
:format
- Specifies the format of the date.
The values for :format
can be:
:sigil
- Returns the date in sigil~D
format (default).:iso8601
- Returns the date in ISO 8601 format.
Examples
iex> NeoFaker.Date.add()
~D[2025-03-25]
iex> NeoFaker.Date.add(0..31)
~D[2025-03-30]
iex> NeoFaker.Date.add(0..31, format: :iso8601)
"2025-03-25"
Generates a random date between two dates.
Returns a date between the specified start and finish dates.
Options
:format
- Specifies the format of the date.
The values for :format
can be:
:sigil
- Returns the date in sigil~D
format (default).:iso8601
- Returns the date in ISO 8601 format.
Examples
iex> NeoFaker.Date.between()
~D[2025-03-25]
iex> NeoFaker.Date.between(~D[2020-01-01], ~D[2025-01-01])
~D[2022-08-17]
iex> NeoFaker.Date.between(~D[2025-03-25], ~D[2025-03-25], format: :iso8601)
"2025-03-25"
Generates a random birthday.
Returns a birthday within the specified age range.
Options
:format
- Specifies the format of the date.
The values for :format
can be:
:sigil
- Returns the date in sigil~D
format (default).:iso8601
- Returns the date in ISO 8601 format.
Examples
iex> NeoFaker.Date.birthday()
~D[1997-01-02]
iex> NeoFaker.Date.birthday(18, 65)
~D[1998-03-04]
iex> NeoFaker.Date.birthday(18, 65, format: :iso8601)
"1999-05-06"