@parischap/conversions 0.1.0

package/dts/DateTime.d.ts

@@ -0,0 +1,1421 @@
+/**
+ * This module implements an immutable DateTime 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
+ * 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.
+ *
+ * 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.
+ */
+import { MInputError, MInspectable, MTypes } from '@parischap/effect-lib';
+import { DateTime, Either, Equal, Equivalence, Inspectable, Option, Pipeable, Predicate } from 'effect';
+/**
+ * Module tag
+ *
+ * @category Module markers
+ */
+export declare const moduleTag = "@parischap/conversions/DateTime/";
+declare const _TypeId: unique symbol;
+type _TypeId = typeof _TypeId;
+/**
+ * Duration of a second in milliseconds
+ *
+ * @category Constants
+ */
+export declare const SECOND_MS = 1000;
+/**
+ * Duration of a minute in milliseconds
+ *
+ * @category Constants
+ */
+export declare const MINUTE_MS: number;
+/**
+ * Duration of an hour in milliseconds
+ *
+ * @category Constants
+ */
+export declare const HOUR_MS: number;
+/**
+ * Duration of a day in milliseconds
+ *
+ * @category Constants
+ */
+export declare const DAY_MS: number;
+/**
+ * Duration of a week in milliseconds
+ *
+ * @category Constants
+ */
+export declare const WEEK_MS: number;
+/**
+ * Duration of a normal year in milliseconds
+ *
+ * @category Constants
+ */
+export declare const COMMON_YEAR_MS: number;
+/**
+ * Duration of a leap year in milliseconds
+ *
+ * @category Constants
+ */
+export declare const LEAP_YEAR_MS: number;
+/**
+ * Duration of a short iso year in milliseconds
+ *
+ * @category Constants
+ */
+export declare const SHORT_YEAR_MS: number;
+/**
+ * Duration of a long iso year in milliseconds
+ *
+ * @category Constants
+ */
+export declare const LONG_YEAR_MS: number;
+/**
+ * Local time zone offset in hours of the machine on which this code runs. The value is calculated
+ * once at startup.
+ *
+ * @category Constants
+ */
+export declare const LOCAL_TIME_ZONE_OFFSET: number;
+/**
+ * Maximal usable year (ECMA-262)
+ *
+ * @category Constants
+ */
+export declare const MAX_FULL_YEAR: number;
+/**
+ * Minimal usable year (ECMA-262)
+ *
+ * @category Constants
+ */
+export declare const MIN_FULL_YEAR: number;
+/**
+ * Maximal usable timestamp (ECMA-262)
+ *
+ * @category Constants
+ */
+export declare const MAX_TIMESTAMP = 8640000000000000;
+/**
+ * Minimal usable timestamp (ECMA-262)
+ *
+ * @category Constants
+ */
+export declare const MIN_TIMESTAMP: number;
+/**
+ * Namespace for the a Gregorian date
+ *
+ * It is important to note that the Gregorian calendar is periodic with a 400-year period as far as
+ * leap years are concerned. Leap years are those that can be divided by 4, except those that can be
+ * divided by 100 except those that can be divided by 400. So 2100, 2200, 2300 are not leap years.
+ * But 2400 is a leap year.
+ *
+ * @category Models
+ */
+declare namespace GregorianDate {
+    const _TypeId: unique symbol;
+    type _TypeId = typeof _TypeId;
+    /**
+     * Type of a GregorianDate
+     *
+     * @category Models
+     */
+    export interface Type extends Inspectable.Inspectable, Pipeable.Pipeable {
+        /** Timestamp of any moment in the day represented by this GregorianDate */
+        readonly timestamp: number;
+        /** The year of this GregorianDate , range: [MIN_FULL_YEAR, MAX_FULL_YEAR] */
+        readonly year: number;
+        /** `true` if `year` is a leap year. `false` otherwise */
+        readonly yearIsLeap: boolean;
+        /** Timestamp of the first millisecond of UTC `year` */
+        readonly yearStartTimestamp: number;
+        /** Position in the year of the day of this GregorianDate, range:[1, 366] */
+        readonly ordinalDay: number;
+        /** Month of this GregorianDate, range:[1, 12] */
+        readonly month: Option.Option<number>;
+        /** Position in the month of the day of this GregorianDate, range:[1, 31] */
+        readonly monthDay: Option.Option<number>;
+        readonly [_TypeId]: _TypeId;
+    }
+    /**
+     * Type guard
+     *
+     * @category Guards
+     */
+    export const has: (u: unknown) => u is Type;
+    /**
+     * Constructs a GregorianDate from a timestamp
+     *
+     * @category Constructors
+     */
+    export const fromTimestamp: (timestamp: number) => Type;
+    /**
+     * If possible, returns a new GregorianDate having `year` set to `year` and the same `month` and
+     * `monthDay` as `self`. Returns a left of an error otherwise. `year` must be an integer comprised
+     * in the range [MIN_FULL_YEAR, MAX_FULL_YEAR]. If `self` represents a 29th of february, `year`
+     * must be a leap year.
+     *
+     * @category Setters
+     */
+    export const setYear: (year: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a new GregorianDate having `month` set to `month` and the same `year` and
+     * `monthDay` 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). `month` must also have at
+     * least `monthDay` days.
+     *
+     * @category Setters
+     */
+    export const setMonth: (month: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a new GregorianDate having `monthDay` set to `monthDay` and the same
+     * `year` and `month` 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.
+     *
+     * @category Setters
+     */
+    export const setMonthDay: (monthDay: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a new GregorianDate having `ordinalDay` set to `ordinalDay` and the same
+     * `year` 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: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * Returns the `timestamp` property of `self`
+     *
+     * @category Destructors
+     */
+    export const timestamp: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `year` property of `self`
+     *
+     * @category Destructors
+     */
+    export const year: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `yearIsLeap` property of `self`
+     *
+     * @category Destructors
+     */
+    export const yearIsLeap: Predicate.Predicate<Type>;
+    /**
+     * Returns the `yearStartTimestamp` property of `self`
+     *
+     * @category Destructors
+     */
+    export const yearStartTimestamp: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `ordinalDay` property of `self`
+     *
+     * @category Destructors
+     */
+    export const ordinalDay: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `month` of `self`
+     *
+     * @category Destructors
+     */
+    export const getMonth: (self: Type) => number;
+    /**
+     * Returns the `monthDay` of `self`
+     *
+     * @category Destructors
+     */
+    export const getMonthDay: (self: Type) => number;
+    /**
+     * Returns the duration of the year described by `self` in milliseconds
+     *
+     * @category Destructors
+     */
+    export const getYearDurationInMs: (self: Type) => number;
+    /**
+     * Returns the duration of the year described by `self` in days
+     *
+     * @category Destructors
+     */
+    export const getYearDurationInDays: (self: Type) => number;
+    /**
+     * Returns the number of days from the start of the `year` property of `self` to the day before
+     * the first day of month `month`
+     *
+     * @category Destructors
+     */
+    export const getMonthOffset: (month: number) => (self: Type) => number;
+    /**
+     * Returns the number of days of month `month` of the `year` property of `self`
+     *
+     * @category Destructors
+     */
+    export const getNumberOfDaysInMonth: (month: number) => MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the ISO representation of this Gregorian Date
+     *
+     * @category Destructors
+     */
+    export const getIsoString: MTypes.OneArgFunction<Type, string>;
+    export {};
+}
+/**
+ * Namespace for an IsoDate.
+ *
+ * An iso year starts on the first day of the first iso week. An iso week starts on a monday and
+ * ends on a sunday. The first iso week of the year is the one that contains January 4th (see
+ * Wikipedia).
+ *
+ * @category Models
+ */
+declare namespace IsoDate {
+    /**
+     * Type of an IsoYearDescriptor
+     *
+     * @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] */
+        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] */
+        readonly isoWeek: Option.Option<number>;
+        /** The weekday of this DateTime, range:[1, 7], 1 is monday, 7 is sunday */
+        readonly weekday: Option.Option<number>;
+    }
+    /**
+     * Type guard
+     *
+     * @category Guards
+     */
+    const has: (u: unknown) => u is Type;
+    /**
+     * Constructs an IsoDate from a timestamp
+     *
+     * @category Constructors
+     */
+    const fromTimestamp: (timestamp: number) => Type;
+    /**
+     * Constructs an IsoDate from a GregorianDate
+     *
+     * @category Constructors
+     */
+    const fromGregorianDate: (gregorianDate: GregorianDate.Type) => Type;
+    /**
+     * If possible, returns a new IsoDate having `year` set to `year` and the same `isoWeek` and
+     * `weekday` as `self`. Returns a left of an error otherwise. `year` must be an integer comprised
+     * in the range [MIN_FULL_YEAR, MAX_FULL_YEAR]. If the isoWeek of `self` is equal to 53, `year`
+     * must be a long year.
+     *
+     * @category Setters
+     */
+    const setYear: (year: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a new IsoDate having `isoWeek` set to `isoWeek` and the same `year` and
+     * `weekday` as `self`. Returns a 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: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a new IsoDate having `weekday` set to `weekday` and the same `year` and
+     * `isoWeek` as `self`. Returns a 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: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * Returns the `timestamp` property of `self`
+     *
+     * @category Destructors
+     */
+    const timestamp: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `year` property of `self`
+     *
+     * @category Destructors
+     */
+    const year: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `yearStartTimestamp` property of `self`
+     *
+     * @category Destructors
+     */
+    const yearStartTimestamp: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `yearIsLong` property of `self`
+     *
+     * @category Destructors
+     */
+    const yearIsLong: Predicate.Predicate<Type>;
+    /**
+     * Returns the `isoWeek` of `self`
+     *
+     * @category Destructors
+     */
+    const getIsoWeek: (self: Type) => number;
+    /**
+     * Returns the `weekday` of `self`
+     *
+     * @category Destructors
+     */
+    const getWeekday: (self: Type) => number;
+    /**
+     * Returns the duration of the year described by `self` in milliseconds
+     *
+     * @category Destructors
+     */
+    const getMsDuration: (self: Type) => number;
+    /**
+     * Returns the duration of the year described by `self` in milliseconds
+     *
+     * @category Destructors
+     */
+    const getLastIsoWeek: (self: Type) => number;
+    /**
+     * Returns the ISO representation of this Gregorian Date
+     *
+     * @category Destructors
+     */
+    const getIsoString: MTypes.OneArgFunction<Type, string>;
+}
+/**
+ * Namespace for the data relative to the time
+ *
+ * @category Models
+ */
+declare namespace Time {
+    /**
+     * Type of a Time
+     *
+     * @category Models
+     */
+    interface Type extends Inspectable.Inspectable, Pipeable.Pipeable {
+        /** This Time expressed in milliseconds, range:[0, DAY_MS[ */
+        readonly timestampOffset: number;
+        /** Hour23 of this Time, range:[0, 23] */
+        readonly hour23: number;
+        /** Hour11 of this Time, range:[0, 11] */
+        readonly hour11: number;
+        /** Meridiem of this Time, 0 for 'AM', 12 for 'PM' */
+        readonly meridiem: 0 | 12;
+        /** Minute of this Time, range:[0, 59] */
+        readonly minute: number;
+        /** Second of this Time, range:[0, 59] */
+        readonly second: number;
+        /** Millisecond of this Time, range:[0, 999] */
+        readonly millisecond: number;
+    }
+    /**
+     * Type guard
+     *
+     * @category Guards
+     */
+    const has: (u: unknown) => u is Type;
+    /**
+     * Constructs the Time that corresponds to the passed `timestampOffset` which is the number of
+     * milliseconds from the start of the current day
+     *
+     * @category Constructors
+     */
+    const fromTimestamp: (timestampOffset: number) => Type;
+    /**
+     * If possible, returns a right of a copy of `self` with `hour23` set to `hour23`. 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
+     *
+     * @category Setters
+     */
+    const setHour23: (hour23: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a right of a copy of `self` with `hour11` set to `hour11`. Returns a 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: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * Returns a copy of `self` with `meridiem` set to `merdiem`.
+     *
+     * @category Setters
+     */
+    const setMeridiem: (meridiem: 0 | 12) => (self: Type) => Type;
+    /**
+     * If possible, returns a right of a copy of `self` with `minute` set to `minute`. 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
+     *
+     * @category Setters
+     */
+    const setMinute: (minute: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a right of a copy of `self` with `second` set to `second`. 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
+     *
+     * @category Setters
+     */
+    const setSecond: (second: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * If possible, returns a right of a copy of `self` with `millisecond` set to `millisecond`.
+     * 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: number) => (self: Type) => Either.Either<Type, MInputError.Type>;
+    /**
+     * Returns the `timestampOffset` property of `self`
+     *
+     * @category Destructors
+     */
+    const timestampOffset: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `hour23` property of `self`
+     *
+     * @category Destructors
+     */
+    const hour23: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `hour11` property of `self`
+     *
+     * @category Destructors
+     */
+    const hour11: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `meridiem` property of `self`
+     *
+     * @category Destructors
+     */
+    const meridiem: MTypes.OneArgFunction<Type, 0 | 12>;
+    /**
+     * Returns the `minute` property of `self`
+     *
+     * @category Destructors
+     */
+    const minute: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `second` property of `self`
+     *
+     * @category Destructors
+     */
+    const second: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `millisecond` property of `self`
+     *
+     * @category Destructors
+     */
+    const millisecond: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the ISO representation of this Gregorian Date
+     *
+     * @category Destructors
+     */
+    const getIsoString: MTypes.OneArgFunction<Type, string>;
+}
+/**
+ * Namespace for the data relative to the parts of a zone offset
+ *
+ * @category Models
+ */
+declare namespace ZoneOffsetParts {
+    /**
+     * Type of a ZoneOffsetParts. Note that ZoneOffsetParts with hour=-0, minute=10, second=0 is
+     * different from hour=0, minute=10, second=0. The first corresponds to the string 'GMT-00:10', a
+     * negative 10-minute offset, the second one to the string 'GMT+00:10', a positive 10-minute
+     * offset.
+     *
+     * @category Models
+     */
+    interface Type extends Inspectable.Inspectable, Pipeable.Pipeable {
+        /** Hour part, range: [-12,14] */
+        readonly zoneHour: number;
+        /** Minute part, range: [0, 59] */
+        readonly zoneMinute: number;
+        /** Second part, range: [0, 59] */
+        readonly zoneSecond: number;
+    }
+    /**
+     * Type guard
+     *
+     * @category Guards
+     */
+    const has: (u: unknown) => u is Type;
+    const _make: (params: MTypes.Data<Type>) => Type;
+    /**
+     * Builds a ZoneOffsetParts from `zoneOffset`
+     *
+     * @category Constructors
+     */
+    const fromZoneOffset: (zoneOffset: number) => Type;
+    /**
+     * Tries to build a ZoneOffsetParts from `zoneHour`, `zoneMinute`, `zoneSecond`. Returns a `some`
+     * if successful. A `none` otherwise.
+     *
+     * - `zoneHour` must be greater than or equal to -12 and less than or equal to 14.
+     * - `zoneMinute` must be greater than or equal to 0 and less than or equal to 59.
+     * - `zoneSecond` must be greater than or equal to 0 and less than or equal to 59.
+     *
+     * @category Constructors
+     */
+    const fromParts: ({ zoneHour, zoneMinute, zoneSecond }: {
+        readonly zoneHour: number;
+        readonly zoneMinute: number;
+        readonly zoneSecond: number;
+    }) => Either.Either<Type, MInputError.Type>;
+    /**
+     * Returns the `zoneHour` property of `self`
+     *
+     * @category Destructors
+     */
+    const zoneHour: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `zoneMinute` property of `self`
+     *
+     * @category Destructors
+     */
+    const zoneMinute: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the `zoneSecond` property of `self`
+     *
+     * @category Destructors
+     */
+    const zoneSecond: MTypes.OneArgFunction<Type, number>;
+    /**
+     * Returns the ISO representation of this Gregorian Date
+     *
+     * @category Destructors
+     */
+    const getIsoString: MTypes.OneArgFunction<Type, string>;
+    /**
+     * Returns the value of `self` expressed in hours
+     *
+     * @category Destructors
+     */
+    const toHour: (self: Type) => number;
+}
+/**
+ * Type of a DateTime
+ *
+ * @category Models
+ */
+export interface Type extends Equal.Equal, MInspectable.Type, Pipeable.Pipeable {
+    /** Timestamp of this DateTime (timezone-independent) */
+    readonly timestamp: number;
+    /** GregorianDate of this DateTime, expressed in given timezone */
+    readonly gregorianDate: Option.Option<GregorianDate.Type>;
+    /** IsoDate of this DateTime, expressed in given timezone */
+    readonly isoDate: Option.Option<IsoDate.Type>;
+    /** Time of this DateTime, expressed in given timezone */
+    readonly time: Option.Option<Time.Type>;
+    /**
+     * Offset in hours between the time of the zone for which all calculations of that DateTime object
+     * will be carried out and UTC time (e.g zoneOffset=1 for timezone +1:00). Not necessarily an
+     * integer, range: ]-13, 15[
+     */
+    readonly zoneOffset: number;
+    /** ZoneOffset decomposed into its parts */
+    readonly zoneOffsetParts: Option.Option<ZoneOffsetParts.Type>;
+    readonly [_TypeId]: _TypeId;
+}
+/**
+ * Type guard
+ *
+ * @category Guards
+ */
+export declare const has: (u: unknown) => u is Type;
+/**
+ * Equivalence
+ *
+ * @category Equivalences
+ */
+export declare const equivalence: Equivalence.Equivalence<Type>;
+/**
+ * Returns the ISO representation of this DateTime
+ *
+ * @category Destructors
+ */
+export declare const getIsoString: (self: Type) => string;
+/**
+ * Tries to build a DateTime 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.
+ *
+ * `timestamp` must be greater than or equal to MIN_TIMESTAMP and less than or equal to
+ * MAX_TIMESTAMP.
+ *
+ * If `zoneOffset` is omitted, the local time zone offset of the machine this code is running on is
+ * used.
+ *
+ * `zoneOffset` can be expressed as as a number of hours. In this case, it must be strictly greater
+ * to -13 and strictly less than 15.
+ *
+ * It can also be expressed as an object containing three components:
+ *
+ * - `zoneHour` which must be greater than or equal to -12 and less than or equal to 14.
+ * - `zoneMinute` which must be greater than or equal to 0 and less than or equal to 59.
+ * - `zoneSecond` which must be greater than or equal to 0 and less than or equal to 59.
+ *
+ * Note that zoneHour=-0, zoneMinute=10, zoneSecond=0 is different from zoneHour=0, zoneMinute=10,
+ * zoneSecond=0. The first corresponds to the string 'GMT-00:10', a negative 10-minute offset, the
+ * second one to the string 'GMT+00:10', a positive 10-minute offset.
+ *
+ * `timestamp`, `zoneHour`, `zoneMinute` and `zoneSecond` should be integers. `zoneOffset`, when
+ * expressed as a number of hours, does not need to be an integer.
+ *
+ * @category Constructors
+ */
+export declare const fromTimestamp: (timestamp: number, zoneOffset?: number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: number;
+    readonly zoneSecond: number;
+}) => Either.Either<Type, MInputError.Type>;
+/**
+ * Same as fromTimestamp but returns directly the DateTime or throws if it cannot be built
+ *
+ * @category Constructors
+ */
+export declare const fromTimestampOrThrow: (timestamp: number, zoneOffset?: number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: number;
+    readonly zoneSecond: number;
+}) => Type;
+/**
+ * Builds a DateTime using Date.now() as timestamp. `zoneOffset` is set to 0.
+ *
+ * @category Constructors
+ */
+export declare const now: () => Type;
+/**
+ * Namespace for the different parts of a date
+ *
+ * @category Models
+ */
+export declare namespace Parts {
+    /**
+     * Type of a Parts
+     *
+     * @category Models
+     */
+    interface Type {
+        /** The Gregorian year, range: [MIN_FULL_YEAR, MAX_FULL_YEAR] */
+        readonly year?: number;
+        /** Number of days elapsed since the start of year, range:[1, 366] */
+        readonly ordinalDay?: number;
+        /** Month in the current year, range:[1, 12] */
+        readonly month?: number;
+        /** Day in the current month, range:[1, 12] */
+        readonly monthDay?: number;
+        /** The iso year, range: [MIN_FULL_YEAR, MAX_FULL_YEAR] */
+        readonly isoYear?: number;
+        /** The iso week in the current iso year, range:[1, 53] */
+        readonly isoWeek?: number;
+        /** Week day in the current iso week, range:[1, 7], 1 is monday, 7 is sunday */
+        readonly weekday?: number;
+        /** Number of hours since the start of the current day, range:[0, 23] */
+        readonly hour23?: number;
+        /** Number of hours since the start of the current meridiem, range:[0, 11] */
+        readonly hour11?: number;
+        /** Meridiem offset of this DateTime in hours, 0 for 'AM', 12 for 'PM' */
+        readonly meridiem?: 0 | 12;
+        /** Number of minutes since the start of the current hour, range:[0, 59] */
+        readonly minute?: number;
+        /** Number of seconds, since sthe start of the current minute, range:[0, 59] */
+        readonly second?: number;
+        /** Number of milliseconds, since sthe start of the current second, range:[0, 999] */
+        readonly millisecond?: number;
+        /**
+         * Offset in hours between the time in the local zone and UTC time (e.g zoneOffset=1 for
+         * timezone +1:00). Not necessarily an integer, range: ]-13, 15[
+         */
+        readonly zoneOffset?: number;
+        /** Hour part of the zoneOffset. Should be an integer in the range: [-12, 14] */
+        readonly zoneHour?: number;
+        /** Minute part of the zoneOffset. Should be an integer in the range: [0, 59] */
+        readonly zoneMinute?: number;
+        /** Second part of the zoneOffset. Should be an integer in the range: [0, 59] */
+        readonly zoneSecond?: number;
+    }
+}
+/**
+ * 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.
+ *
+ * `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
+ * be greater than or equal to 1 (January) and less than or equal to 12 (December). `monthDay` must
+ * be greater than or equal to 1 and less than or equal to the number of days in the current month.
+ *
+ * `isoYear` must be comprised in the range [MIN_FULL_YEAR, MAX_FULL_YEAR]. `isoWeek` must be
+ * greater than or equal to 1 and less than or equal to the number of iso weeks in the current year.
+ * `weekday` must be greater than or equal to 1 (monday) and less than or equal to 7 (sunday).
+ *
+ * If there is not sufficient information to determine the exact day of the year, i.e. none of the
+ * three following tuples is fully determined [year, ordinalDay], [year, month, monthDay], [isoYear,
+ * isoWeek, weekday], default values are determined in the following order (the first match stops
+ * the process):
+ *
+ * - If `year` and `month` are set, `monthDay` is taken equal to 1.
+ * - If `year` and `monthDay` are set, `month` is taken equal to 1.
+ * - If `year` is set and both `month` and `monthDay` are undefined, the day is taken to be the first
+ *   one in the year.
+ * - If `isoYear` and `isoWeek` are set, `weekday` is taken equal to 1.
+ * - If `isoYear` and `weekday` are set, `isoWeek` is taken equal to 1.
+ * - If `isoYear` is set and both `isoWeek` and `weekday` are undefined, the day is taken to be the
+ *   first one in the iso year.
+ * - If both `year` and `isoYear` are undefined, an error is raised.
+ *
+ * `hour23` must be greater than or equal to 0 and less than or equal to 23. `hour11` must be
+ * greater than or equal to 0 and less than or equal to 11. `meridiem` must be one of 0 (AM) or 12
+ * (PM). If there is not sufficient information to determine the hour of the day, i.e. none of the
+ * two following tuples is fully determined [hour23], [hour11, meridiem], default values are
+ * determined as follows:
+ *
+ * - If `meridiem` is set, `hour11` is taken equal to 0.
+ * - If `hour11` is set, `meridiem` is taken equal to 0.
+ * - Otherwise, `meridiem` and `hour11` are taken equal to 0.
+ *
+ * `minute` must be greater than or equal to 0 and less than or equal to 59. If omitted, minute is
+ * assumed to be 0.
+ *
+ * `second` must be greater than or equal to 0 and less than or equal to 59. If omitted, second is
+ * assumed to be 0.
+ *
+ * `millisecond` must be greater than or equal to 0 and less than or equal to 999. If omitted,
+ * millisecond is assumed to be 0.
+ *
+ * `zoneOffset` must be strictly greater to -13 and strictly less than 15. `zoneHour` must be
+ * greater than or equal to -12 and less than or equal to 14. `zoneMinute` must be greater than or
+ * equal to 0 and less than or equal to 59. `zoneSecond` must be greater than or equal to 0 and less
+ * than or equal to 59.
+ *
+ * If there is not sufficient information to determine the exact time zone offset, i.e. none of the
+ * two following tuples is fully determined [zoneOffset], [zoneHour, zoneMinute, zoneSecond],
+ * default values are determined as follows :
+ *
+ * - If all parameters are undefined, the local time zone offset of the machine this code is running
+ *   on is used.
+ * - If any of `zoneHour`, `zoneMinute`, `zoneSecond`, the undefined parameters are taken equal to 0.
+ *
+ * Note that zoneHour=-0, zoneMinute=10, zoneSecond=0 is different from zoneHour=0, zoneMinute=10,
+ * zoneSecond=0. The first corresponds to the string 'GMT-00:10', a negative 10-minute offset, the
+ * second one to the string 'GMT+00:10', a positive 10-minute offset.
+ *
+ * `year`, `ordinalDay`, `month`, `monthDay`, `isoYear`, `isoWeek`, `weekDay`, `hour23`, `hour11`,
+ * `minute`, `second`, `millisecond`, `zoneHour`, `zoneMinute` and `zoneSecond` should be integers.
+ * `zoneOffset` does not need to be an integer.
+ *
+ * All parameters must be coherent. For instance, `year=1970`, `month=1`, `monthDay=1`, `weekday=0`
+ * `zoneHour=0`, `zoneMinute=0` and `zoneSecond=0` will trigger an error because 1/1/1970
+ * 00:00:00:000+0:00 is a thursday. `hour23=13` and `meridiem=0` will also trigger an error.
+ *
+ * @category Constructors
+ */
+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
+ *
+ * @category Constructors
+ */
+export declare const fromPartsOrThrow: (parts: Parts.Type) => Type;
+/**
+ * Builds a CVDateTime from a Javascript Date
+ *
+ * @category Constructors
+ */
+export declare const fromDate: (date: Date) => Type;
+/**
+ * Builds a CVDateTime from an Effect DateTime
+ *
+ * @category Constructors
+ */
+export declare const fromEffectDateTime: (date: DateTime.Zoned) => Type;
+/**
+ * Builds a Javascript Date from a CVDateTime
+ *
+ * @category Conversions
+ */
+export declare const toDate: (self: Type) => Date;
+/**
+ * Builds an Effect DateTime from a CVDateTime
+ *
+ * @category Conversions
+ */
+export declare const toEffectDateTime: (self: Type) => DateTime.Zoned;
+/**
+ * Returns the timestamp of `self` as a number
+ *
+ * @category Getters
+ */
+export declare const timestamp: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the (Gregorian) year of `self` for the given time zone
+ *
+ * @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
+ *
+ * @category Getters
+ */
+export declare const getOrdinalDay: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the month of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getMonth: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the monthDay of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getMonthDay: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the isoYear of `self` for the given time zone
+ *
+ * @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
+ *
+ * @category Getters
+ */
+export declare const getIsoWeek: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the weekday of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getWeekday: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the hour23 of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getHour23: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the hour11 of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getHour11: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the meridiem of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getMeridiem: MTypes.OneArgFunction<Type, 0 | 12>;
+/**
+ * Returns the minute of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getMinute: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the second of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getSecond: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the millisecond of `self` for the given time zone
+ *
+ * @category Getters
+ */
+export declare const getMillisecond: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the hour part of the zoneOffset of `self`
+ *
+ * @category Getters
+ */
+export declare const getZoneHour: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the minute part of the zoneOffset of `self`
+ *
+ * @category Getters
+ */
+export declare const getZoneMinute: MTypes.OneArgFunction<Type, number>;
+/**
+ * Returns the minute part of the zoneOffset of `self`
+ *
+ * @category Getters
+ */
+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,
+ * 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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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)
+ *
+ * @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
+ *
+ * @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`
+ * 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.
+ *
+ * @category Setters
+ */
+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
+ *
+ * @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`,
+ * `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,
+ * 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
+ *
+ * @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`,
+ * `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
+ * 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
+ *
+ * @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`,
+ * `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)
+ * 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
+ *
+ * @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
+ * an error otherwise. `hour23` must be an integer greater than or equal to 0 and less than or equal
+ * to 23
+ *
+ * @category Setters
+ */
+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
+ *
+ * @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`,
+ * `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
+ * 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
+ *
+ * @category Setters
+ */
+export declare const setHour11OrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
+/**
+ * Returns a DateTime 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
+ * an error otherwise. `minute` must be an integer greater than or equal to 0 and less than or equal
+ * to 59
+ *
+ * @category Setters
+ */
+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
+ *
+ * @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
+ * an error otherwise. `second` must be an integer greater than or equal to 0 and less than or equal
+ * to 59
+ *
+ * @category Setters
+ */
+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
+ *
+ * @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.
+ *
+ * @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
+ *
+ * @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 `zoneOffset` is omitted, the local time zone offset of the machine this code is running on is
+ * used.
+ *
+ * `zoneOffset` can be expressed as as a number of hours. In this case, it must be strictly greater
+ * to -13 and strictly less than 15.
+ *
+ * It can also be expressed as an object containing three components:
+ *
+ * - `zoneHour` which must be greater than or equal to -12 and less than or equal to 14.
+ * - `zoneMinute` which must be greater than or equal to 0 and less than or equal to 59.
+ * - `zoneSecond` which must be greater than or equal to 0 and less than or equal to 59.
+ *
+ * `zoneHour`, `zoneMinute` and `zoneSecond` should be integers. `zoneOffset`, when expressed as a
+ * number of hours, does not need to be an integer.
+ *
+ * @category Setters
+ */
+export declare const setZoneOffsetKeepTimestamp: (zoneOffset?: number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: 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
+ *
+ * @category Setters
+ */
+export declare const setZoneOffsetKeepTimestampOrThrow: MTypes.OneArgFunction<number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: number;
+    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`.
+ *
+ * See setZoneOffsetKeepTimestamp for more details
+ *
+ * @category Setters
+ */
+export declare const setZoneOffsetKeepParts: (zoneOffset?: number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: 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
+ *
+ * @category Setters
+ */
+export declare const setZoneOffsetKeepPartsOrThrow: MTypes.OneArgFunction<number | {
+    readonly zoneHour: number;
+    readonly zoneMinute: number;
+    readonly zoneSecond: number;
+}, MTypes.OneArgFunction<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
+ *
+ * @category Predicates
+ */
+export declare const isLastMonthDay: Predicate.Predicate<Type>;
+/**
+ * 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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @category Predicates
+ */
+export declare const isLastIsoYearDay: Predicate.Predicate<Type>;
+/**
+ * Returns a copy of `self` where `monthDay` is set to the first day of the current month. All time
+ * parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`, `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toFirstMonthDay: MTypes.OneArgFunction<Type>;
+/**
+ * Returns a copy of `self` where `monthDay` is set to the last day of the current month. All time
+ * parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`, `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toLastMonthDay: (self: Type) => Type;
+/**
+ * Returns a copy of `self` where `ordinalDay` is set to the first day of the current year. All time
+ * parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`, `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toFirstYearDay: (self: Type) => Type;
+/**
+ * Returns a copy of `self` where `ordinalDay` is set to the last day of the current year. All time
+ * parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`, `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toLastYearDay: (self: Type) => Type;
+/**
+ * Returns a copy of `self` where `isoWeek` and `weekday` are set to 1. All time parts (`hour23`,
+ * `hour11`, `meridiem`, `minute`, `second`, `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toFirstIsoYearDay: MTypes.OneArgFunction<Type>;
+/**
+ * Returns a copy of `self` where `isoWeek` is set to the last week of the current iso year.
+ * `weekday` and all time parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`, `millisecond`)
+ * are left unchanged
+ *
+ * @category Offsetters
+ */
+export declare const toLastIsoYearWeek: (self: Type) => Type;
+/**
+ * Returns a copy of `self` where `isoWeek` is set to the last week of the current iso year and
+ * `weekday` is set to 7. All time parts (`hour23`, `hour11`, `meridiem`, `minute`, `second`,
+ * `millisecond`) are left unchanged
+ *
+ * @category Offsetters
+ */
+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.
+ *
+ * @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
+ *
+ * @category Setters
+ */
+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
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetMonthsOrThrow: (offset: number, respectMonthEnd: boolean) => MTypes.OneArgFunction<Type>;
+/**
+ * Returns a copy of `self` offset by `offset` days
+ *
+ * @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
+ *
+ * @category Setters
+ */
+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.
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetIsoYearsOrThrow: (offset: number, respectYearEnd: boolean) => MTypes.OneArgFunction<Type>;
+/**
+ * Returns a copy of `self` offset by `offset` hours
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetHoursOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
+/**
+ * Returns a copy of `self` offset by `offset` minutes
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetMinutesOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
+/**
+ * Returns a copy of `self` offset by `offset` seconds
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetSecondsOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
+/**
+ * Returns a copy of `self` offset by `offset` milliseconds
+ *
+ * @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
+ *
+ * @category Setters
+ */
+export declare const offsetMillisecondsOrThrow: MTypes.OneArgFunction<number, MTypes.OneArgFunction<Type>>;
+export {};
+//# sourceMappingURL=DateTime.d.ts.map