@parischap/conversions 0.1.0 → 0.3.0

package/dts/DateTime.d.ts

@@ -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 { MInputError, MInspectable, MTypes } from '@parischap/effect-lib';
 import { DateTime, Either, Equal, Equivalence, Inspectable, Option, Pipeable, Predicate } from 'effect';
@@ -209,7 +210,7 @@ declare namespace GregorianDate {
     /**
      * Returns the `yearIsLeap` property of `self`
      *
-     * @category Destructors
+     * @category Predicates
      */
     export const yearIsLeap: Predicate.Predicate<Type>;
     /**
@@ -280,22 +281,22 @@ declare namespace GregorianDate {
  */
 declare namespace IsoDate {
     /**
-     * Type of an IsoYearDescriptor
+     * Type of an IsoDate
      *
      * @category Models
      */
     interface Type extends Inspectable.Inspectable, Pipeable.Pipeable {
         /** Timestamp of any moment of the day represented by this IsoDate */
         readonly timestamp: number;
-        /** The iso year of this IsoDate, range: [MIN_FULL_YEAR, MAX_FULL_YEAR] */
+        /** The Iso year of this IsoDate, range: [MIN_FULL_YEAR, MAX_FULL_YEAR] */
         readonly year: number;
         /** If true, iso year `year` counts 53 weeks. Otherwise, it counts 52 weeks */
         readonly yearIsLong: boolean;
         /** Timestamp of the first millisecond of UTC iso year `year` */
         readonly yearStartTimestamp: number;
-        /** The iso week of this IsoYear, range:[1, 53] */
+        /** The Iso week of this IsoDate, range:[1, 53] */
         readonly isoWeek: Option.Option<number>;
-        /** The weekday of this DateTime, range:[1, 7], 1 is monday, 7 is sunday */
+        /** The weekday of this IsoDate, range:[1, 7], 1 is monday, 7 is sunday */
         readonly weekday: Option.Option<number>;
     }
     /**
@@ -362,7 +363,7 @@ declare namespace IsoDate {
     /**
      * Returns the `yearIsLong` property of `self`
      *
-     * @category Destructors
+     * @category Predicates
      */
     const yearIsLong: Predicate.Predicate<Type>;
     /**
@@ -655,9 +656,9 @@ export declare const equivalence: Equivalence.Equivalence<Type>;
  */
 export declare const getIsoString: (self: Type) => string;
 /**
- * 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.
@@ -689,7 +690,7 @@ export declare const fromTimestamp: (timestamp: number, zoneOffset?: number | {
     readonly zoneSecond: number;
 }) => Either.Either<Type, MInputError.Type>;
 /**
- * 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
  */
@@ -699,7 +700,7 @@ export declare const fromTimestampOrThrow: (timestamp: number, zoneOffset?: numb
     readonly zoneSecond: number;
 }) => Type;
 /**
- * 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
  */
@@ -756,8 +757,8 @@ export declare namespace Parts {
     }
 }
 /**
- * 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
@@ -831,31 +832,31 @@ export declare namespace Parts {
  */
 export declare const fromParts: ({ year, ordinalDay, month, monthDay, isoYear, isoWeek, weekday, hour23, hour11, meridiem, minute, second, millisecond, zoneOffset, zoneHour, zoneMinute, zoneSecond }: Parts.Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const fromPartsOrThrow: (parts: Parts.Type) => Type;
 /**
- * Builds a CVDateTime from a Javascript Date
+ * Builds a `CVDateTime` from a Javascript `Date`
  *
  * @category Constructors
  */
 export declare const fromDate: (date: Date) => Type;
 /**
- * Builds a CVDateTime from an Effect DateTime
+ * Builds a `CVDateTime` from an `Effect.DateTime.Zoned`
  *
  * @category Constructors
  */
 export declare const fromEffectDateTime: (date: DateTime.Zoned) => Type;
 /**
- * Builds a Javascript Date from a CVDateTime
+ * Builds a Javascript `Date` from a `CVDateTime`
  *
  * @category Conversions
  */
 export declare const toDate: (self: Type) => Date;
 /**
- * Builds an Effect DateTime from a CVDateTime
+ * Builds an `Effect.DateTime.Zoned` from a `CVDateTime`
  *
  * @category Conversions
  */
@@ -872,13 +873,6 @@ export declare const timestamp: MTypes.OneArgFunction<Type, number>;
  * @category Getters
  */
 export declare const getYear: MTypes.OneArgFunction<Type, number>;
-/**
- * Returns true if the (Gregorian) year of `self` for the given time zone is a leap year. Returns
- * false otherwise
- *
- * @category Getters
- */
-export declare const yearIsLeap: MTypes.OneArgFunction<Type, boolean>;
 /**
  * Returns the ordinalDay of `self` for the given time zone
  *
@@ -903,13 +897,6 @@ export declare const getMonthDay: MTypes.OneArgFunction<Type, number>;
  * @category Getters
  */
 export declare const getIsoYear: MTypes.OneArgFunction<Type, number>;
-/**
- * Returns true if the isoYear of `self` for the given time zone is a long year. Returns false
- * otherwise
- *
- * @category Getters
- */
-export declare const isoYearIsLong: MTypes.OneArgFunction<Type, boolean>;
 /**
  * Returns the isoWeek of `self` for the given time zone
  *
@@ -977,53 +964,53 @@ export declare const getZoneMinute: MTypes.OneArgFunction<Type, number>;
  */
 export declare const getZoneSecond: MTypes.OneArgFunction<Type, number>;
 /**
- * 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 declare const setYear: (year: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setYearOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setOrdinalDay: (ordinalDay: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setOrdinalDayOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setMonth: (month: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setMonthOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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.
  *
@@ -1031,59 +1018,59 @@ export declare const setMonthOrThrow: MTypes.OneArgFunction<number, MTypes.OneAr
  */
 export declare const setMonthDay: (monthDay: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setMonthDayOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setIsoYear: (isoYear: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setIsoYearOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setIsoWeek: (isoWeek: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setIsoWeekOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setWeekday: (weekday: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setWeekdayOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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
  *
@@ -1091,36 +1078,36 @@ export declare const setWeekdayOrThrow: MTypes.OneArgFunction<number, MTypes.One
  */
 export declare const setHour23: (hour23: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setHour23OrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setHour11: (hour11: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setHour11OrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setMeridiem: (meridiem: 0 | 12) => (self: Type) => Type;
 /**
- * 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
  *
@@ -1128,14 +1115,14 @@ export declare const setMeridiem: (meridiem: 0 | 12) => (self: Type) => Type;
  */
 export declare const setMinute: (minute: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setMinuteOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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
  *
@@ -1143,29 +1130,29 @@ export declare const setMinuteOrThrow: MTypes.OneArgFunction<number, MTypes.OneA
  */
 export declare const setSecond: (second: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setSecondOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const setMillisecond: (millisecond: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const setMillisecondOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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.
@@ -1190,7 +1177,8 @@ export declare const setZoneOffsetKeepTimestamp: (zoneOffset?: number | {
     readonly zoneSecond: number;
 }) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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
  */
@@ -1200,10 +1188,10 @@ export declare const setZoneOffsetKeepTimestampOrThrow: MTypes.OneArgFunction<nu
     readonly zoneSecond: number;
 }, MTypes.OneArgFunction<Type>>;
 /**
- * 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
  */
@@ -1213,7 +1201,8 @@ export declare const setZoneOffsetKeepParts: (zoneOffset?: number | {
     readonly zoneSecond: number;
 }) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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
  */
@@ -1223,37 +1212,51 @@ export declare const setZoneOffsetKeepPartsOrThrow: MTypes.OneArgFunction<number
     readonly zoneSecond: number;
 }, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const yearIsLeap: Predicate.Predicate<Type>;
+/**
+ * Returns true if the isoYear of `self` for the given time zone is a long year. Returns false
+ * otherwise
+ *
+ * @category Predicates
+ */
+export declare const isoYearIsLong: Predicate.Predicate<Type>;
+/**
+ * Returns true if `self` is the first day of a month in the given timezone
  *
  * @category Predicates
  */
 export declare const isFirstMonthDay: Predicate.Predicate<Type>;
 /**
- * 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 declare const isLastMonthDay: Predicate.Predicate<Type>;
 /**
- * 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 declare const isFirstYearDay: Predicate.Predicate<Type>;
 /**
- * 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 declare const isLastYearDay: Predicate.Predicate<Type>;
 /**
- * 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 declare const isFirstIsoYearDay: Predicate.Predicate<Type>;
 /**
- * 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
  */
@@ -1310,111 +1313,116 @@ export declare const toLastIsoYearWeek: (self: Type) => Type;
  */
 export declare const toLastIsoYearDay: (self: Type) => Type;
 /**
- * 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 declare const offsetYears: (offset: number, respectMonthEnd: boolean) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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 declare const offsetYearsOrThrow: (offset: number, respectMonthEnd: boolean) => MTypes.OneArgFunction<Type>;
 /**
- * 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
  */
 export declare const offsetMonths: (offset: number, respectMonthEnd: boolean) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const offsetMonthsOrThrow: (offset: number, respectMonthEnd: boolean) => MTypes.OneArgFunction<Type>;
 /**
- * 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 declare const offsetDays: (offset: number) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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 declare const offsetDaysOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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
  */
 export declare const offsetIsoYears: (offset: number, respectYearEnd: boolean) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const offsetIsoYearsOrThrow: (offset: number, respectYearEnd: boolean) => MTypes.OneArgFunction<Type>;
 /**
- * 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 declare const offsetHours: (offset: number) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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 declare const offsetHoursOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const offsetMinutes: (offset: number) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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 declare const offsetMinutesOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const offsetSeconds: (offset: number) => MTypes.OneArgFunction<Type, Either.Either<Type, MInputError.Type>>;
 /**
- * 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 declare const offsetSecondsOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 /**
- * 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 declare const offsetMilliseconds: (offset: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
 /**
- * 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 declare const offsetMillisecondsOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
 export {};