@parischap/conversions 0.1.0 → 0.3.0

package/cjs/DateTime.js

@@ -32,23 +32,24 @@ function _interopRequireWildcard(e, t) {
   })(e, t);
 }
 /**
- * This module implements an immutable DateTime object.
+ * This module implements an immutable `CVDateTime` object.
  *
- * DateTime objects keep an internal state. But all provided functions look pure insofar as they
- * will always yield the same result whatever the state the object is in. The state is only used to
+ * `CVDateTime` objects keep an internal state. But all provided functions are pure insofar as they
+ * always yield the same result whatever the state the object is in. The state is only used to
  * improve performance but does not alter the results.
  *
- * Unlike the Javascript Date objects and the Effect DateTime objects, DateTime objects handle both
- * the Gregorian and Iso calendars. So you can easily get/set the iso year and iso week of a
- * DateTime object.
+ * Unlike the Javascript `Date` objects and the Effect `DateTime` objects, `CVDateTime` objects
+ * handle both the Gregorian and Iso calendars. So you can easily get/set the iso year and iso week
+ * of a `CVDateTime` object.
  *
- * A DateTime object has a `zoneOffset` which is the difference in hours between the time in the
- * local zone and UTC time (e.g zoneOffset=1 for timezone +1:00). All the data in a DateTime object
- * is `zoneOffset-dependent`, except `timestamp`. An important thing to note is that a DateTime
- * object with a timestamp t and a zoneOffset zo has exactly the same date parts (year, ordinalDay,
- * month, monthDay, isoYear...) as a DateTime object with a timestamp t+zox3600 and a 0 zoneOffset.
- * That's the reason for the _zonedTimestamp field which is equal to t+zox3600. All calculations are
- * performed UTC using _zonedTimestamp instead of timestamp.
+ * A `CVDateTime` object has a `zoneOffset` which is the difference in hours between the time in the
+ * local zone and UTC time (e.g `zoneOffset=1` for timezone +1:00). All the data in a `CVDateTime`
+ * object is `zoneOffset-dependent`, except `timestamp`. An important thing to note is that a
+ * `CVDateTime` object with a timestamp `t` and a zoneOffset `zo` has exactly the same date parts
+ * (`year`, `ordinalDay`, `month`, `monthDay`, `isoYear`...) as a `CVDateTime` object with
+ * `timestamp = t+zox3600` and `zoneOffset = 0`. That's the reason for the _zonedTimestamp field
+ * which is equal to `t+zox3600`. All calculations are performed UTC using _zonedTimestamp instead
+ * of timestamp.
  */
 
 /**
@@ -386,7 +387,7 @@ var GregorianDate;
   /**
    * Returns the `yearIsLeap` property of `self`
    *
-   * @category Destructors
+   * @category Predicates
    */
   GregorianDate.yearIsLeap = /*#__PURE__*/_effect.Struct.get('yearIsLeap');
   /**
@@ -738,7 +739,7 @@ var IsoDate;
   /**
    * Returns the `yearIsLong` property of `self`
    *
-   * @category Destructors
+   * @category Predicates
    */
   IsoDate.yearIsLong = /*#__PURE__*/_effect.Struct.get('yearIsLong');
   /**
@@ -1237,9 +1238,9 @@ const _uncalculatedFromZonedTimestamp = (zonedTimestamp, zoneOffset) => _make({
 /** Instance of an uncalculated DateTime that represents 1/1/1970 00:00:00:000+0:00 */
 const _uncalculatedOrigin = /*#__PURE__*/_uncalculatedFromTimestamp(0, 0);
 /**
- * Tries to build a DateTime from `timestamp`, the number of milliseconds since 1/1/1970
+ * Tries to build a `CVDateTime` from `timestamp`, the number of milliseconds since 1/1/1970
  * 00:00:00:000+0:00, and `zoneOffset` which gives the offset between the local time and the UTC
- * time. Returns a `right` of a DateTime if successful.
+ * time. Returns a `Right` if successful, a `Left` otherwise.
  *
  * `timestamp` must be greater than or equal to MIN_TIMESTAMP and less than or equal to
  * MAX_TIMESTAMP.
@@ -1267,21 +1268,21 @@ const _uncalculatedOrigin = /*#__PURE__*/_uncalculatedFromTimestamp(0, 0);
  */
 const fromTimestamp = (timestamp, zoneOffset) => (0, _effect.pipe)(_uncalculatedOrigin, _setTimestamp(timestamp), _effect.Either.flatMap(setZoneOffsetKeepTimestamp(zoneOffset)));
 /**
- * Same as fromTimestamp but returns directly the DateTime or throws if it cannot be built
+ * Same as `fromTimestamp` but returns directly a `CVDateTime` or throws if it cannot be built
  *
  * @category Constructors
  */
 exports.fromTimestamp = fromTimestamp;
 const fromTimestampOrThrow = exports.fromTimestampOrThrow = /*#__PURE__*/(0, _effect.flow)(fromTimestamp, /*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity));
 /**
- * Builds a DateTime using Date.now() as timestamp. `zoneOffset` is set to 0.
+ * Builds a `CVDateTime` using Date.now() as `timestamp`. `zoneOffset` is set to 0.
  *
  * @category Constructors
  */
 const now = () => _uncalculatedFromTimestamp(Date.now(), 0);
 /**
- * Tries to build a DateTime from the provided DateTime parts. Returns a `right` of this DateTime if
- * successful. Returns a `left` of an error otherwise.
+ * Tries to build a `CVDateTime` from the provided parts. Returns a `Right` if successful, a `Left`
+ * otherwise.
  *
  * `year` must comprised in the range [MIN_FULL_YEAR, MAX_FULL_YEAR]. `ordinalDay` must be greater
  * than or equal to 1 and less than or equal to the number of days in the current year. `month` must
@@ -1476,34 +1477,34 @@ const fromParts = ({
   return withWeekday;
 });
 /**
- * Same as fromParts but returns directly the DateTime or throws if it cannot be built
+ * Same as `fromParts` but returns directly a `CVDateTime` or throws if it cannot be built
  *
  * @category Constructors
  */
 exports.fromParts = fromParts;
 const fromPartsOrThrow = exports.fromPartsOrThrow = /*#__PURE__*/(0, _effect.flow)(fromParts, /*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity));
 /**
- * Builds a CVDateTime from a Javascript Date
+ * Builds a `CVDateTime` from a Javascript `Date`
  *
  * @category Constructors
  */
 const fromDate = date => fromTimestampOrThrow(date.getTime());
 /**
- * Builds a CVDateTime from an Effect DateTime
+ * Builds a `CVDateTime` from an `Effect.DateTime.Zoned`
  *
  * @category Constructors
  */
 exports.fromDate = fromDate;
 const fromEffectDateTime = date => fromTimestampOrThrow(_effect.DateTime.toEpochMillis(date), _effect.DateTime.zonedOffset(date));
 /**
- * Builds a Javascript Date from a CVDateTime
+ * Builds a Javascript `Date` from a `CVDateTime`
  *
  * @category Conversions
  */
 exports.fromEffectDateTime = fromEffectDateTime;
 const toDate = self => new Date(timestamp(self));
 /**
- * Builds an Effect DateTime from a CVDateTime
+ * Builds an `Effect.DateTime.Zoned` from a `CVDateTime`
  *
  * @category Conversions
  */
@@ -1518,7 +1519,7 @@ const toEffectDateTime = self => _effect.DateTime.unsafeMakeZoned(timestamp(self
  */
 exports.toEffectDateTime = toEffectDateTime;
 const timestamp = exports.timestamp = /*#__PURE__*/_effect.Struct.get('timestamp');
-/** Returns the gregorianDate of `self` for the given time zone */
+/** Returns the `gregorianDate` of `self` for the given time zone */
 const _gregorianDate = self => (0, _effect.pipe)(self.gregorianDate, _effect.Option.getOrElse(() => {
   const result = GregorianDate.fromTimestamp(self._zonedTimestamp);
   /* eslint-disable-next-line functional/immutable-data, functional/no-expression-statements */
@@ -1531,13 +1532,6 @@ const _gregorianDate = self => (0, _effect.pipe)(self.gregorianDate, _effect.Opt
  * @category Getters
  */
 const getYear = exports.getYear = /*#__PURE__*/(0, _effect.flow)(_gregorianDate, GregorianDate.year);
-/**
- * Returns true if the (Gregorian) year of `self` for the given time zone is a leap year. Returns
- * false otherwise
- *
- * @category Getters
- */
-const yearIsLeap = exports.yearIsLeap = /*#__PURE__*/(0, _effect.flow)(_gregorianDate, GregorianDate.yearIsLeap);
 /**
  * Returns the ordinalDay of `self` for the given time zone
  *
@@ -1569,13 +1563,6 @@ const _isoDate = self => (0, _effect.pipe)(self.isoDate, _effect.Option.getOrEls
  * @category Getters
  */
 const getIsoYear = exports.getIsoYear = /*#__PURE__*/(0, _effect.flow)(_isoDate, IsoDate.year);
-/**
- * Returns true if the isoYear of `self` for the given time zone is a long year. Returns false
- * otherwise
- *
- * @category Getters
- */
-const isoYearIsLong = exports.isoYearIsLong = /*#__PURE__*/(0, _effect.flow)(_isoDate, IsoDate.yearIsLong);
 /**
  * Returns the isoWeek of `self` for the given time zone
  *
@@ -1692,56 +1679,56 @@ const _timeSetter = self => {
   };
 };
 /**
- * If possible, returns a right of a DateTime having year `year` and the same `month`, `monthDay`,
- * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of an
- * error otherwise. `year` must be an integer comprised in the range [MIN_FULL_YEAR,
+ * If possible, returns a `Right` of a `CVDateTime` having year `year` and the same `month`,
+ * `monthDay`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
+ * `Left` otherwise. `year` must be an integer comprised in the range [MIN_FULL_YEAR,
  * MAX_FULL_YEAR].
  *
  * @category Setters
  */
 const setYear = year => self => (0, _effect.pipe)(self, _gregorianDate, GregorianDate.setYear(year), _effect.Either.map(_gregorianDateSetter(self)));
 /**
- * Same as setYear but returns directly a DateTime or throws in case of an error
+ * Same as `setYear` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setYear = setYear;
 const setYearOrThrow = exports.setYearOrThrow = /*#__PURE__*/(0, _effect.flow)(setYear, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having ordinalDay `ordinalDay` and the same `year`,
- * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of an
- * error otherwise. `ordinalDay` must be an integer greater than or equal to 1 and less than or
- * equal to the number of days in the current year
+ * If possible, returns a `Right` of a `CVDateTime` having ordinalDay `ordinalDay` and the same
+ * `year`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left`
+ * of an error otherwise. `ordinalDay` must be an integer greater than or equal to 1 and less than
+ * or equal to the number of days in the current year
  *
  * @category Setters
  */
 const setOrdinalDay = ordinalDay => self => (0, _effect.pipe)(self, _gregorianDate, GregorianDate.setOrdinalDay(ordinalDay), _effect.Either.map(_gregorianDateSetter(self)));
 /**
- * Same as setOrdinalDay but returns directly a DateTime or throws in case of an error
+ * Same as `setOrdinalDay` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setOrdinalDay = setOrdinalDay;
 const setOrdinalDayOrThrow = exports.setOrdinalDayOrThrow = /*#__PURE__*/(0, _effect.flow)(setOrdinalDay, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having month `month` and the same `year`, `monthDay`,
- * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of an
- * error otherwise. `month` must be an integer greater than or equal to 1 (January) and less than or
- * equal to 12 (December)
+ * If possible, returns a `Right` of a `CVDateTime` having month `month` and the same `year`,
+ * `monthDay`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
+ * `Left` of an error otherwise. `month` must be an integer greater than or equal to 1 (January) and
+ * less than or equal to 12 (December)
  *
  * @category Setters
  */
 const setMonth = month => self => (0, _effect.pipe)(self, _gregorianDate, GregorianDate.setMonth(month), _effect.Either.map(_gregorianDateSetter(self)));
 /**
- * Same as setMonth but returns directly a DateTime or throws in case of an error
+ * Same as `setMonth` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setMonth = setMonth;
 const setMonthOrThrow = exports.setMonthOrThrow = /*#__PURE__*/(0, _effect.flow)(setMonth, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having monthDay `monthDay` and the same `year`,
- * `month`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left`
+ * If possible, returns a `Right` of a `CVDateTime` having monthDay `monthDay` and the same `year`,
+ * `month`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left`
  * of an error otherwise. `monthDay` must be an integer greater than or equal to 1 and less than or
  * equal to the number of days in the current month.
  *
@@ -1749,63 +1736,63 @@ const setMonthOrThrow = exports.setMonthOrThrow = /*#__PURE__*/(0, _effect.flow)
  */
 const setMonthDay = monthDay => self => (0, _effect.pipe)(self, _gregorianDate, GregorianDate.setMonthDay(monthDay), _effect.Either.map(_gregorianDateSetter(self)));
 /**
- * Same as setMonthDay but returns directly a DateTime or throws in case of an error
+ * Same as `setMonthDay` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setMonthDay = setMonthDay;
 const setMonthDayOrThrow = exports.setMonthDayOrThrow = /*#__PURE__*/(0, _effect.flow)(setMonthDay, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having isoYear `isoYear` and the same `isoWeek`,
+ * If possible, returns a `Right` of a `CVDateTime` having isoYear `isoYear` and the same `isoWeek`,
  * `weekday`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
- * `left` of an error otherwise. `isoYear` must be an integer comprised in the range [MIN_FULL_YEAR,
+ * `Left` of an error otherwise. `isoYear` must be an integer comprised in the range [MIN_FULL_YEAR,
  * MAX_FULL_YEAR].
  *
  * @category Setters
  */
 const setIsoYear = isoYear => self => (0, _effect.pipe)(self, _isoDate, IsoDate.setYear(isoYear), _effect.Either.map(_isoDateSetter(self)));
 /**
- * Same as setIsoYear but returns directly a DateTime or throws in case of an error
+ * Same as `setIsoYear` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setIsoYear = setIsoYear;
 const setIsoYearOrThrow = exports.setIsoYearOrThrow = /*#__PURE__*/(0, _effect.flow)(setIsoYear, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having isoWeek `isoWeek` and the same `isoYear`,
+ * If possible, returns a Right of a `CVDateTime` having isoWeek `isoWeek` and the same `isoYear`,
  * `weekday`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
- * `left` of an error otherwise. `isoWeek` must be an integer greater than or equal to 1 and less
+ * `Left` of an error otherwise. `isoWeek` must be an integer greater than or equal to 1 and less
  * than or equal to the number of iso weeks in the current year.
  *
  * @category Setters
  */
 const setIsoWeek = isoWeek => self => (0, _effect.pipe)(self, _isoDate, IsoDate.setIsoWeek(isoWeek), _effect.Either.map(_isoDateSetter(self)));
 /**
- * Same as setIsoWeek but returns directly a DateTime or throws in case of an error
+ * Same as `setIsoWeek` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setIsoWeek = setIsoWeek;
 const setIsoWeekOrThrow = exports.setIsoWeekOrThrow = /*#__PURE__*/(0, _effect.flow)(setIsoWeek, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having weekday `weekday` and the same `isoYear`,
+ * If possible, returns a `Right` of a `CVDateTime` having weekday `weekday` and the same `isoYear`,
  * `isoWeek`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
- * `left` of an error otherwise. `weekday` must be an integer greater than or equal to 1 (monday)
+ * `Left` of an error otherwise. `weekday` must be an integer greater than or equal to 1 (monday)
  * and less than or equal to 7 (sunday).
  *
  * @category Setters
  */
 const setWeekday = weekday => self => (0, _effect.pipe)(self, _isoDate, IsoDate.setWeekday(weekday), _effect.Either.map(_isoDateSetter(self)));
 /**
- * Same as setWeekday but returns directly a DateTime or throws in case of an error
+ * Same as `setWeekday` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setWeekday = setWeekday;
 const setWeekdayOrThrow = exports.setWeekdayOrThrow = /*#__PURE__*/(0, _effect.flow)(setWeekday, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having hour23 `hour23` and the same `year`,
- * `ordinalDay`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of
+ * If possible, returns a `Right` of a `CVDateTime` having hour23 `hour23` and the same `year`,
+ * `ordinalDay`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left` of
  * an error otherwise. `hour23` must be an integer greater than or equal to 0 and less than or equal
  * to 23
  *
@@ -1813,38 +1800,38 @@ const setWeekdayOrThrow = exports.setWeekdayOrThrow = /*#__PURE__*/(0, _effect.f
  */
 const setHour23 = hour23 => self => (0, _effect.pipe)(self, _time, Time.setHour23(hour23), _effect.Either.map(_timeSetter(self)));
 /**
- * Same as setHour23 but returns directly a DateTime or throws in case of an error
+ * Same as `setHour23` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setHour23 = setHour23;
 const setHour23OrThrow = exports.setHour23OrThrow = /*#__PURE__*/(0, _effect.flow)(setHour23, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having hour11 `hour11` and the same `year`,
+ * If possible, returns a Right of a `CVDateTime` having hour11 `hour11` and the same `year`,
  * `ordinalDay`, `meridiem`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
- * `left` of an error otherwise. `hour11` must be an integer greater than or equal to 0 and less
+ * `Left` of an error otherwise. `hour11` must be an integer greater than or equal to 0 and less
  * than or equal to 11.
  *
  * @category Setters
  */
 const setHour11 = hour11 => self => (0, _effect.pipe)(self, _time, Time.setHour11(hour11), _effect.Either.map(_timeSetter(self)));
 /**
- * Same as setHour11 but returns directly a DateTime or throws in case of an error
+ * Same as `setHour11` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setHour11 = setHour11;
 const setHour11OrThrow = exports.setHour11OrThrow = /*#__PURE__*/(0, _effect.flow)(setHour11, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a DateTime having meridiem `meridiem` and the same `year`, `ordinalDay`, `hour11`,
+ * Returns a `CVDateTime` having meridiem `meridiem` and the same `year`, `ordinalDay`, `hour11`,
  * `minute`, `second`, `millisecond` and `zoneOffset` as `self`
  *
  * @category Setters
  */
 const setMeridiem = meridiem => self => (0, _effect.pipe)(self, _time, Time.setMeridiem(meridiem), _timeSetter(self));
 /**
- * If possible, returns a right of a DateTime having minute `minute` and the same `year`,
- * `ordinalDay`, `hour23`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of
+ * If possible, returns a `Right` of a `CVDateTime` having minute `minute` and the same `year`,
+ * `ordinalDay`, `hour23`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left` of
  * an error otherwise. `minute` must be an integer greater than or equal to 0 and less than or equal
  * to 59
  *
@@ -1853,15 +1840,15 @@ const setMeridiem = meridiem => self => (0, _effect.pipe)(self, _time, Time.setM
 exports.setMeridiem = setMeridiem;
 const setMinute = minute => self => (0, _effect.pipe)(self, _time, Time.setMinute(minute), _effect.Either.map(_timeSetter(self)));
 /**
- * Same as setMinute but returns directly a DateTime or throws in case of an error
+ * Same as `setMinute` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setMinute = setMinute;
 const setMinuteOrThrow = exports.setMinuteOrThrow = /*#__PURE__*/(0, _effect.flow)(setMinute, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having second `second` and the same `year`,
- * `ordinalDay`, `hour23`, `minute`, `millisecond` and `zoneOffset` as `self`. Returns a `left` of
+ * If possible, returns a Right of a `CVDateTime` having second `second` and the same `year`,
+ * `ordinalDay`, `hour23`, `minute`, `millisecond` and `zoneOffset` as `self`. Returns a `Left` of
  * an error otherwise. `second` must be an integer greater than or equal to 0 and less than or equal
  * to 59
  *
@@ -1869,31 +1856,31 @@ const setMinuteOrThrow = exports.setMinuteOrThrow = /*#__PURE__*/(0, _effect.flo
  */
 const setSecond = second => self => (0, _effect.pipe)(self, _time, Time.setSecond(second), _effect.Either.map(_timeSetter(self)));
 /**
- * Same as setSecond but returns directly a DateTime or throws in case of an error
+ * Same as `setSecond` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setSecond = setSecond;
 const setSecondOrThrow = exports.setSecondOrThrow = /*#__PURE__*/(0, _effect.flow)(setSecond, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a DateTime having millisecond `millisecond` and the same `year`,
- * `ordinalDay`, `hour23`, `minute`, `second` and `zoneOffset` as `self`. Returns a `left` of an
- * error otherwise. `millisecond` must be an integer greater than or equal to 0 and less than or
- * equal to 999.
+ * If possible, returns a `Right` of a `CVDateTime` having millisecond `millisecond` and the same
+ * `year`, `ordinalDay`, `hour23`, `minute`, `second` and `zoneOffset` as `self`. Returns a `Left`
+ * of an error otherwise. `millisecond` must be an integer greater than or equal to 0 and less than
+ * or equal to 999.
  *
  * @category Setters
  */
 const setMillisecond = millisecond => self => (0, _effect.pipe)(self, _time, Time.setMillisecond(millisecond), _effect.Either.map(_timeSetter(self)));
 /**
- * Same as setMillisecond but returns directly a DateTime or throws in case of an error
+ * Same as `setMillisecond` but returns directly a `CVDateTime` or throws in case of an error
  *
  * @category Setters
  */
 exports.setMillisecond = setMillisecond;
 const setMillisecondOrThrow = exports.setMillisecondOrThrow = /*#__PURE__*/(0, _effect.flow)(setMillisecond, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a copy of `self` with timestamp set to `timestamp`. Returns a
- * `left` of an error otherwise. `timestamp` must be an integer comprised in the range
+ * If possible, returns a `Right` of a copy of `self` with timestamp set to `timestamp`. Returns a
+ * `Left` of an error otherwise. `timestamp` must be an integer comprised in the range
  * [MIN_TIMESTAMP, MAX_TIMESTAMP] representing the number of milliseconds since 1/1/1970
  * 00:00:00:000+0:00.
  */
@@ -1928,8 +1915,8 @@ const _setZoneOffset = (keepTimestamp, zoneOffset = LOCAL_TIME_ZONE_OFFSET) => s
   return result;
 });
 /**
- * If possible, returns a right of a copy of `self` with the same timestamp and zoneOffset set to
- * `zoneOffset`.
+ * If possible, returns a `Right` of a copy of `self` with the same `timestamp` and zoneOffset set
+ * to `zoneOffset`.
  *
  * If `zoneOffset` is omitted, the local time zone offset of the machine this code is running on is
  * used.
@@ -1950,64 +1937,80 @@ const _setZoneOffset = (keepTimestamp, zoneOffset = LOCAL_TIME_ZONE_OFFSET) => s
  */
 const setZoneOffsetKeepTimestamp = zoneOffset => _setZoneOffset(true, zoneOffset);
 /**
- * Same as setZoneOffsetKeepTimestamp but returns directly a DateTime or throws in case of an error
+ * Same as `setZoneOffsetKeepTimestamp` but returns directly a `CVDateTime` or throws in case of an
+ * error
  *
  * @category Setters
  */
 exports.setZoneOffsetKeepTimestamp = setZoneOffsetKeepTimestamp;
 const setZoneOffsetKeepTimestampOrThrow = exports.setZoneOffsetKeepTimestampOrThrow = /*#__PURE__*/(0, _effect.flow)(setZoneOffsetKeepTimestamp, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a right of a copy of `self` with the same CVDateTime.Parts (except
- * zoneOffset) and zoneOffset set to `zoneOffset`.
+ * If possible, returns a `Right` of a copy of `self` with the same parts (except `zoneOffset`) and
+ * zoneOffset set to `zoneOffset`.
  *
- * See setZoneOffsetKeepTimestamp for more details
+ * See `setZoneOffsetKeepTimestamp` for more details
  *
  * @category Setters
  */
 const setZoneOffsetKeepParts = zoneOffset => _setZoneOffset(false, zoneOffset);
 /**
- * Same as setZoneOffsetKeepTimestamp but returns directly a DateTime or throws in case of an error
+ * Same as `setZoneOffsetKeepTimestamp` but returns directly a `CVDateTime` or throws in case of an
+ * error
  *
  * @category Setters
  */
 exports.setZoneOffsetKeepParts = setZoneOffsetKeepParts;
 const setZoneOffsetKeepPartsOrThrow = exports.setZoneOffsetKeepPartsOrThrow = /*#__PURE__*/(0, _effect.flow)(setZoneOffsetKeepParts, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns true if self is the first day of a month in the given timezone
+ * Returns true if the (Gregorian) year of `self` for the given time zone is a leap year. Returns
+ * false otherwise
+ *
+ * @category Predicates
+ */
+const yearIsLeap = exports.yearIsLeap = /*#__PURE__*/(0, _effect.flow)(_gregorianDate, GregorianDate.yearIsLeap);
+/**
+ * Returns true if the isoYear of `self` for the given time zone is a long year. Returns false
+ * otherwise
+ *
+ * @category Predicates
+ */
+const isoYearIsLong = exports.isoYearIsLong = /*#__PURE__*/(0, _effect.flow)(_isoDate, IsoDate.yearIsLong);
+/**
+ * Returns true if `self` is the first day of a month in the given timezone
  *
  * @category Predicates
  */
 const isFirstMonthDay = self => getMonthDay(self) === 1;
 /**
- * Returns true if self is the last day of a month in the given timezone
+ * Returns true if `self` is the last day of a month in the given timezone
  *
  * @category Predicates
  */
 exports.isFirstMonthDay = isFirstMonthDay;
 const isLastMonthDay = self => getMonthDay(self) === (0, _effect.pipe)(self, _gregorianDate, GregorianDate.getNumberOfDaysInMonth(getMonth(self)));
 /**
- * Returns true if self is the first day of a year in the given timezone
+ * Returns true if `self` is the first day of a year in the given timezone
  *
  * @category Predicates
  */
 exports.isLastMonthDay = isLastMonthDay;
 const isFirstYearDay = self => getOrdinalDay(self) === 1;
 /**
- * Returns true if self is the last day of a year in the given timezone
+ * Returns true if `self` is the last day of a year in the given timezone
  *
  * @category Predicates
  */
 exports.isFirstYearDay = isFirstYearDay;
 const isLastYearDay = self => getOrdinalDay(self) === (0, _effect.pipe)(self, _gregorianDate, GregorianDate.getYearDurationInDays);
 /**
- * Returns true if self is the first day of an iso year in the given timezone
+ * Returns true if `self` is the first day of an iso year in the given timezone
  *
  * @category Predicates
  */
 exports.isLastYearDay = isLastYearDay;
 const isFirstIsoYearDay = self => getIsoWeek(self) === 1 && getWeekday(self) === 1;
 /**
- * Returns true if self is the last day of an iso year in the given timezone
+ * Returns true if `self` is the last day of an iso year in the given timezone
  *
  * @category Predicates
  */
@@ -2070,29 +2073,29 @@ const toLastIsoYearWeek = self => (0, _effect.pipe)(self, setIsoWeekOrThrow((0,
 exports.toLastIsoYearWeek = toLastIsoYearWeek;
 const toLastIsoYearDay = self => (0, _effect.pipe)(self, toLastIsoYearWeek, setWeekdayOrThrow(7));
 /**
- * If possible, returns a copy of `self` offset by `offset` years and having the same `month`,
- * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. If `respectMonthEnd` is
- * true and `self` is on the last day of a month, the new DateTime object's monthDay will be the
- * last of the target month. Otherwise, it will be the same as `self`'s. Returns a `left` of an
- * error otherwise.
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` years and having the same
+ * `month`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left`
+ * of an error otherwise. If `respectMonthEnd` is true and `self` is on the last day of a month, the
+ * new DateTime object's monthDay will be the last of the target month. Otherwise, it will be the
+ * same as `self`
  *
  * @category Offsetters
  */
 exports.toLastIsoYearDay = toLastIsoYearDay;
 const offsetYears = (offset, respectMonthEnd) => offsetMonths(offset * 12, respectMonthEnd);
 /**
- * Same as offsetYears but returns directly a DateTime or throws in case of an error
+ * Same as `offsetYears` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetYears = offsetYears;
 const offsetYearsOrThrow = exports.offsetYearsOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetYears, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a copy of `self` offset by `offset` months and having the same `hour23`,
- * `minute`, `second`, `millisecond` and `zoneOffset` as `self`. If `respectMonthEnd` is true and
- * `self` is on the last day of a month, the new DateTime object's monthDay will be the last of the
- * target month. Otherwise, it will be the same as `self`'s. Returns a `left` of an error if the
- * DateTime object can
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` months and having the same
+ * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a `Left` of an
+ * error otherwise. If `respectMonthEnd` is true and `self` is on the last day of a month, the new
+ * DateTime object's monthDay will be the last of the target month. Otherwise, it will be the same
+ * as `self`'s
  *
  * @category Offsetters
  */
@@ -2105,31 +2108,32 @@ const offsetMonths = (offset, respectMonthEnd) => self => {
   })));
 };
 /**
- * Same as offsetMonths but returns directly a DateTime or throws in case of an error
+ * Same as `offsetMonths` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetMonths = offsetMonths;
 const offsetMonthsOrThrow = exports.offsetMonthsOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetMonths, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a copy of `self` offset by `offset` days
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` days. Returns a `Left` of
+ * an error otherwise.
  *
  * @category Offsetters
  */
 const offsetDays = offset => offsetMilliseconds(offset * DAY_MS);
 /**
- * Same as offsetDays but returns directly a DateTime or throws in case of an error
+ * Same as `offsetDays` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetDays = offsetDays;
 const offsetDaysOrThrow = exports.offsetDaysOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetDays, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * If possible, returns a copy of `self` offset by `offset` iso years and having the same `weekday`,
- * `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. If `respectYearEnd` is
- * true and `self` is on the last day of an iso year, the new DateTime object's isoWeek will be the
- * last of the target iso year. Otherwise, it will be the same as `self`'s. Returns a `left` of an
- * error otherwise.
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` iso years and having the
+ * same `weekday`, `hour23`, `minute`, `second`, `millisecond` and `zoneOffset` as `self`. Returns a
+ * `Left` of an error otherwise. If `respectYearEnd` is true and `self` is on the last day of an iso
+ * year, the new DateTime object's isoWeek will be the last of the target iso year. Otherwise, it
+ * will be the same as `self`'s.
  *
  * @category Offsetters
  */
@@ -2141,61 +2145,65 @@ const offsetIsoYears = (offset, respectYearEnd) => self => {
   })));
 };
 /**
- * Same as offsetIsoYears but returns directly a DateTime or throws in case of an error
+ * Same as `offsetIsoYears` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetIsoYears = offsetIsoYears;
 const offsetIsoYearsOrThrow = exports.offsetIsoYearsOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetIsoYears, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a copy of `self` offset by `offset` hours
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` hours. Returns a `Left` of
+ * an error otherwise.
  *
  * @category Offsetters
  */
 const offsetHours = offset => offsetMilliseconds(offset * HOUR_MS);
 /**
- * Same as offsetHours but returns directly a DateTime or throws in case of an error
+ * Same as `offsetHours` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetHours = offsetHours;
 const offsetHoursOrThrow = exports.offsetHoursOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetHours, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a copy of `self` offset by `offset` minutes
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` minutes. Returns a `Left`
+ * of an error otherwise.
  *
  * @category Offsetters
  */
 const offsetMinutes = offset => offsetMilliseconds(offset * MINUTE_MS);
 /**
- * Same as offsetMinutes but returns directly a DateTime or throws in case of an error
+ * Same as `offsetMinutes` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetMinutes = offsetMinutes;
 const offsetMinutesOrThrow = exports.offsetMinutesOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetMinutes, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a copy of `self` offset by `offset` seconds
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` seconds. Returns a `Left`
+ * of an error otherwise.
  *
  * @category Offsetters
  */
 const offsetSeconds = offset => offsetMilliseconds(offset * SECOND_MS);
 /**
- * Same as offsetSeconds but returns directly a DateTime or throws in case of an error
+ * Same as `offsetSeconds` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetSeconds = offsetSeconds;
 const offsetSecondsOrThrow = exports.offsetSecondsOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetSeconds, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));
 /**
- * Returns a copy of `self` offset by `offset` milliseconds
+ * If possible, returns a `Right` of a copy of `self` offset by `offset` milliseconds. Returns a
+ * `Left` of an error otherwise.
  *
  * @category Offsetters
  */
 const offsetMilliseconds = offset => self => _setTimestamp(timestamp(self) + offset)(self);
 /**
- * Same as offsetMilliseconds but returns directly a DateTime or throws in case of an error
+ * Same as `offsetMilliseconds` but returns directly a `CVDateTime` or throws in case of an error
  *
- * @category Setters
+ * @category Offsetters
  */
 exports.offsetMilliseconds = offsetMilliseconds;
 const offsetMillisecondsOrThrow = exports.offsetMillisecondsOrThrow = /*#__PURE__*/(0, _effect.flow)(offsetMilliseconds, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Either.getOrThrowWith(_effect.Function.identity)));