@parischap/conversions 0.1.0 → 0.3.0

package/esm/DateTime.js

@@ -1,21 +1,22 @@
 /**
- * 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.
  */
 import { MArray, MFunction, MInputError, MInspectable, MNumber, MPipeable, MStruct, MTypes } from '@parischap/effect-lib';
 import { DateTime, Either, Equal, Function, Hash, Number, Option, Predicate, Struct, flow, pipe } from 'effect';
@@ -358,7 +359,7 @@ var GregorianDate;
   /**
    * Returns the `yearIsLeap` property of `self`
    *
-   * @category Destructors
+   * @category Predicates
    */
   GregorianDate.yearIsLeap = /*#__PURE__*/Struct.get('yearIsLeap');
   /**
@@ -710,7 +711,7 @@ var IsoDate;
   /**
    * Returns the `yearIsLong` property of `self`
    *
-   * @category Destructors
+   * @category Predicates
    */
   IsoDate.yearIsLong = /*#__PURE__*/Struct.get('yearIsLong');
   /**
@@ -1206,9 +1207,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.
@@ -1236,20 +1237,20 @@ const _uncalculatedOrigin = /*#__PURE__*/_uncalculatedFromTimestamp(0, 0);
  */
 export const fromTimestamp = (timestamp, zoneOffset) => pipe(_uncalculatedOrigin, _setTimestamp(timestamp), 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
  */
 export const fromTimestampOrThrow = /*#__PURE__*/flow(fromTimestamp, /*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
@@ -1443,31 +1444,31 @@ export 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
  */
 export const fromPartsOrThrow = /*#__PURE__*/flow(fromParts, /*#__PURE__*/Either.getOrThrowWith(Function.identity));
 /**
- * Builds a CVDateTime from a Javascript Date
+ * Builds a `CVDateTime` from a Javascript `Date`
  *
  * @category Constructors
  */
 export const fromDate = date => fromTimestampOrThrow(date.getTime());
 /**
- * Builds a CVDateTime from an Effect DateTime
+ * Builds a `CVDateTime` from an `Effect.DateTime.Zoned`
  *
  * @category Constructors
  */
 export const fromEffectDateTime = date => fromTimestampOrThrow(DateTime.toEpochMillis(date), DateTime.zonedOffset(date));
 /**
- * Builds a Javascript Date from a CVDateTime
+ * Builds a Javascript `Date` from a `CVDateTime`
  *
  * @category Conversions
  */
 export const toDate = self => new Date(timestamp(self));
 /**
- * Builds an Effect DateTime from a CVDateTime
+ * Builds an `Effect.DateTime.Zoned` from a `CVDateTime`
  *
  * @category Conversions
  */
@@ -1480,7 +1481,7 @@ export const toEffectDateTime = self => DateTime.unsafeMakeZoned(timestamp(self)
  * @category Getters
  */
 export const timestamp = /*#__PURE__*/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 => pipe(self.gregorianDate, Option.getOrElse(() => {
   const result = GregorianDate.fromTimestamp(self._zonedTimestamp);
   /* eslint-disable-next-line functional/immutable-data, functional/no-expression-statements */
@@ -1493,13 +1494,6 @@ const _gregorianDate = self => pipe(self.gregorianDate, Option.getOrElse(() => {
  * @category Getters
  */
 export const getYear = /*#__PURE__*/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
- */
-export const yearIsLeap = /*#__PURE__*/flow(_gregorianDate, GregorianDate.yearIsLeap);
 /**
  * Returns the ordinalDay of `self` for the given time zone
  *
@@ -1531,13 +1525,6 @@ const _isoDate = self => pipe(self.isoDate, Option.getOrElse(() => {
  * @category Getters
  */
 export const getIsoYear = /*#__PURE__*/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
- */
-export const isoYearIsLong = /*#__PURE__*/flow(_isoDate, IsoDate.yearIsLong);
 /**
  * Returns the isoWeek of `self` for the given time zone
  *
@@ -1654,53 +1641,53 @@ 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
  */
 export const setYear = year => self => pipe(self, _gregorianDate, GregorianDate.setYear(year), 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
  */
 export const setYearOrThrow = /*#__PURE__*/flow(setYear, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setOrdinalDay = ordinalDay => self => pipe(self, _gregorianDate, GregorianDate.setOrdinalDay(ordinalDay), 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
  */
 export const setOrdinalDayOrThrow = /*#__PURE__*/flow(setOrdinalDay, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setMonth = month => self => pipe(self, _gregorianDate, GregorianDate.setMonth(month), 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
  */
 export const setMonthOrThrow = /*#__PURE__*/flow(setMonth, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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.
  *
@@ -1708,59 +1695,59 @@ export const setMonthOrThrow = /*#__PURE__*/flow(setMonth, /*#__PURE__*/Function
  */
 export const setMonthDay = monthDay => self => pipe(self, _gregorianDate, GregorianDate.setMonthDay(monthDay), 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
  */
 export const setMonthDayOrThrow = /*#__PURE__*/flow(setMonthDay, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setIsoYear = isoYear => self => pipe(self, _isoDate, IsoDate.setYear(isoYear), 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
  */
 export const setIsoYearOrThrow = /*#__PURE__*/flow(setIsoYear, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setIsoWeek = isoWeek => self => pipe(self, _isoDate, IsoDate.setIsoWeek(isoWeek), 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
  */
 export const setIsoWeekOrThrow = /*#__PURE__*/flow(setIsoWeek, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setWeekday = weekday => self => pipe(self, _isoDate, IsoDate.setWeekday(weekday), 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
  */
 export const setWeekdayOrThrow = /*#__PURE__*/flow(setWeekday, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  *
@@ -1768,36 +1755,36 @@ export const setWeekdayOrThrow = /*#__PURE__*/flow(setWeekday, /*#__PURE__*/Func
  */
 export const setHour23 = hour23 => self => pipe(self, _time, Time.setHour23(hour23), 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
  */
 export const setHour23OrThrow = /*#__PURE__*/flow(setHour23, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setHour11 = hour11 => self => pipe(self, _time, Time.setHour11(hour11), 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
  */
 export const setHour11OrThrow = /*#__PURE__*/flow(setHour11, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setMeridiem = meridiem => self => 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
  *
@@ -1805,14 +1792,14 @@ export const setMeridiem = meridiem => self => pipe(self, _time, Time.setMeridie
  */
 export const setMinute = minute => self => pipe(self, _time, Time.setMinute(minute), 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
  */
 export const setMinuteOrThrow = /*#__PURE__*/flow(setMinute, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  *
@@ -1820,29 +1807,29 @@ export const setMinuteOrThrow = /*#__PURE__*/flow(setMinute, /*#__PURE__*/Functi
  */
 export const setSecond = second => self => pipe(self, _time, Time.setSecond(second), 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
  */
 export const setSecondOrThrow = /*#__PURE__*/flow(setSecond, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export const setMillisecond = millisecond => self => pipe(self, _time, Time.setMillisecond(millisecond), 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
  */
 export const setMillisecondOrThrow = /*#__PURE__*/flow(setMillisecond, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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.
  */
@@ -1877,8 +1864,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.
@@ -1899,58 +1886,74 @@ const _setZoneOffset = (keepTimestamp, zoneOffset = LOCAL_TIME_ZONE_OFFSET) => s
  */
 export 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
  */
 export const setZoneOffsetKeepTimestampOrThrow = /*#__PURE__*/flow(setZoneOffsetKeepTimestamp, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const setZoneOffsetKeepPartsOrThrow = /*#__PURE__*/flow(setZoneOffsetKeepParts, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
+ */
+export const yearIsLeap = /*#__PURE__*/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
+ */
+export const isoYearIsLong = /*#__PURE__*/flow(_isoDate, IsoDate.yearIsLong);
+/**
+ * Returns true if `self` is the first day of a month in the given timezone
  *
  * @category Predicates
  */
 export 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
  */
 export const isLastMonthDay = self => getMonthDay(self) === 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
  */
 export 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
  */
 export const isLastYearDay = self => getOrdinalDay(self) === 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
  */
 export 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
  */
@@ -2007,27 +2010,27 @@ export const toLastIsoYearWeek = self => pipe(self, setIsoWeekOrThrow(pipe(self,
  */
 export const toLastIsoYearDay = self => 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
  */
 export 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
  */
 export const offsetYearsOrThrow = /*#__PURE__*/flow(offsetYears, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
@@ -2040,29 +2043,30 @@ export 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
  */
 export const offsetMonthsOrThrow = /*#__PURE__*/flow(offsetMonths, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const offsetDaysOrThrow = /*#__PURE__*/flow(offsetDays, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
@@ -2074,57 +2078,61 @@ export 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
  */
 export const offsetIsoYearsOrThrow = /*#__PURE__*/flow(offsetIsoYears, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const offsetHoursOrThrow = /*#__PURE__*/flow(offsetHours, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const offsetMinutesOrThrow = /*#__PURE__*/flow(offsetMinutes, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const offsetSecondsOrThrow = /*#__PURE__*/flow(offsetSeconds, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(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
  */
 export 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
  */
 export const offsetMillisecondsOrThrow = /*#__PURE__*/flow(offsetMilliseconds, /*#__PURE__*/Function.compose(/*#__PURE__*/Either.getOrThrowWith(Function.identity)));
 //# sourceMappingURL=DateTime.js.map