nominalDateTime function

Arbitrary<NominalDateTime> nominalDateTime({
  1. DateTime? min,
  2. DateTime? max,
  3. String? location,
  4. bool? imaginary,
})

Returns an arbitrary that generates a nominal datetime value.

The arbitrary generates a datetime containing imaginary dates. Imaginary dates are dates that don't exist in the real world, such as:

  • February 29th in a non-leap year
  • February 30th and 31st
  • The 31st day of April, June, September, and November

Parameters:

  • min: The minimum value to generate. Timezone is ignored.
  • max: The maximum value to generate. Timezone is ignored.
  • location: The location to use when generating the DateTime.
  • imaginary: Whether to include imaginary dates.

Implementation

Arbitrary<NominalDateTime> nominalDateTime({
  DateTime? min,
  DateTime? max,
  String? location,
  bool? imaginary,
}) =>
    DateTimeArbitraries.nominalDateTime(
      min: min,
      max: max,
      location: location,
      imaginary: imaginary,
    );