past/future date functions to support min years

[karlismelderis-mckinsey]

Clear and concise description of the problem

currently past and future supports only option to set max range in years
In case test needs short date in past/future (.toISOString().slice(0, 10) magic 🪄) you can still get date of current day

Suggested solution

to avoid adjusting reference date or manually adding +/- days it would be nice to support additional config to set min diff

e.g.

faker.date.past({yearsMin: 1, years: 2}) // at least 1 year but not more than 2 years in the past

faker.date.future({yearsMin: 1, years: 2}) // at least 1 year but not more than 2 years in the future

I guess same would apply for soon and recent

Alternative

I can use date-fns to add/remove random number of days but it feels bit to ugly

addDays(
          new Date(),
          faker.number.int({ min: 1, max: 20 }),
        )
          .toISOString()
          .slice(0, 10)

Additional context

No response

[github-actions]

Thank you for your feature proposal.

We marked it as "waiting for user interest" for now to gather some feedback from our community:

• If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
• If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

We will start the implementation based on:

• the number of votes ( 👍 ) and comments
• the relevance for the ecosystem
• availability of alternatives and workarounds
• and the complexity of the requested feature

We do this because:

• There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
• Every feature we add to faker has "costs" associated to it:
  • initial costs: design, implementation, reviews, documentation
  • running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

---

View more issues which are waiting for user interest

[xDivisionByZerox]

Please note that faker.date.past() and faker.date.future() are designed to be in further away from the reference date (by default the curretn date-time). If you want to use an API that is closer to the reference date use faker.date.recent() and faker.date.soon().

If you want to create a date that is today you can simply use the generic faker.date.between() function.