@opengeoweb/shared 9.28.1 → 9.29.0

package/src/lib/utils/dateUtils/dateUtils.d.ts

@@ -1,343 +1,343 @@
-import { parseISO, isEqual, Duration, startOfDay, isWithinInterval, getDayOfYear, getDay, getMonth, getYear, getWeek, NearestMinutes } from 'date-fns';
-export interface DateValues {
-    year?: number;
-    month?: number;
-    date?: number;
-    hours?: number;
-    minutes?: number;
-    seconds?: number;
-    milliseconds?: number;
-}
-/**
- * Parsing date strings with geoweb dateUtils:
- *
- * An ISO String *with timezone* can safely be parsed directly to a date:
- *
- * date = new Date('2022-10-10T15:30:00Z')
- * date = new Date('2022-10-10T15:30:00+00:00')
- * date = new Date('2022-10-10T15:30:00+02:00')
- *
- * or using the dateUtils isoStringToDate function *with utc=false*
- *
- * date = isoStringToDate('2022-10-10T15:30:00Z', false)
- *
- * An ISO String *without a timezone* can be parsed with isoStringToDate
- *
- * date = isoStringToDate('2022-10-10T15:30:00')
- *
- * *Do not parse ISO without timezone using `new Date()` unless you correct for the local timezone*
- *
- * To parse an arbitrary date string with timezone use:
- *
- * date = stringToDate('2022.11.10, 11:15 +01:00', 'yyyy.MM.dd, HH:mm xxx', false)
- *
- * To parse an arbitrary date string without timezone use:
- *
- * date = stringToDate('2022.11.10, 11:15', 'yyyy.MM.dd, HH:mm')
- *
- *
- * To safely convert dates to utc strings use:
- *
- * date.toISOString()
- *
- * To get parts of UTC time use
- *
- * date.getUTCHours()
- * date.getUTCMins()
- *
- * To parse an arbitrary date string to a UTC string use:
- *
- * dateToString(new Date('2022-10-10T15:30:00Z'), 'HH:ss dd MMM yyyy')
- *
- */
-/**
- * Parse an ISO string to a date
- *
- * Expects the following props:
- * @param {string} input - string containing date
- *
- * @returns {Date} Date
- * @example
- * ``` isoStringToDate("2022-5-10T20:32:00+00:00") ```
- * ``` isoStringToDate("2022-5-10T20:32:00:00Z", false) ```
- */
-export declare const isoStringToDate: (input: string, utc?: boolean) => Date | undefined;
-export declare const isValidIsoDateString: (input: string) => boolean;
-/**
- * Parse a string to a date
- *
- * ***NOTE: String will be parsed in local time if utc is set to false***
- *
- * Expects the following props:
- * @param {string} input - string containing date
- * @param {string} strFormat - format of the string, see: https://date-fns.org/v2.29.3/docs/parse
- * @param {boolean} utc [ default = true ] - boolean indicating whether to parse as UTC
- * @param {Date} referenceDate [ default = new Date() ] - defines values missing from the parsed dateString
- *
- * @returns {Date} Date
- * @example
- * ``` stringToDate("2022 5 10 20:32", 'yyyy M d HH:mm')) ```
- */
-export declare const stringToDate: (input: string | undefined, strFormat: string, utc?: boolean, referenceDate?: Date | number) => Date | undefined;
-export declare const dateToIsoString: (input: Date | undefined) => string | undefined;
-/**
- * Use this if you initialise a date without a timezone to set it to utc correctly
- * eg.
- *   new Date(2022, 10, 12, 15, 30)
- * should be:
- *   setUTCDate(new Date(2022, 10, 12, 15, 30))
- *
- * Expects the following props:
- * @param {Date} inDate - date to be set to UTC
- *
- * @returns {Date} - Date in UTC
- * @example
- * ``` setUTCDate(new Date(2022, 10, 12, 15, 30)) ```
- */
-export declare const setUTCDate: (inDate: Date | undefined) => Date | undefined;
-/**
- * Format a date to a string
- *
- * Expects the following props:
- * @param {Date} inDate - date to be formatted
- * @param {string} strFormat - [default: "yyyy-MM-dd'T'HH:mm:ss'Z'"] format of string
- * @param {boolean} utc - [default: true] true to return in utc otherwise return in local timezone
- *
- * @returns {string} - formatted date string
- * @example
- * ``` dateToString(new Date(2022, 10, 12, 15, 30), 'dd MMM yyyy') ```
- */
-export declare const dateToString: (inDate: Date | undefined, strFormat?: string, utc?: boolean) => string | undefined;
-/**
- * Find out if a date is between two other dates.
- *
- * Inclusivity parameter matches that used in momentjs where '[' indicates inclusion and '(' indicates exclusion.
- *
- * Expects the following props:
- * @param {Date} date - date to be tested
- * @param {Date} from - first date
- * @param {Date} to - last date
- * @param {string} inclusivity - [default: '()'] Must be one of : '()', '[]', '(]', '[)'
- *
- * @returns {boolen} - true if date is between, otherwise false
- *
- */
-export declare const isBetween: (date: Date, from: Date, to: Date, inclusivity?: string) => boolean;
-/**
- * Creates a new Date object with the specified date and time, or the current date and time if no arguments are provided.
- *
- * @param yearOrIsoString The year for the new Date object, or an ISO-formatted string representing the date and time.
- * @param month The month for the new Date object (0-11).
- * @param day The day for the new Date object (1-31).
- * @param hours The hour for the new Date object (0-23).
- * @param minutes The minute for the new Date object (0-59).
- * @param seconds The second for the new Date object (0-59).
- * @param milliseconds The millisecond for the new Date object (0-999).
- * @returns A new Date object with the specified date and time, or the current date and time if no arguments are provided.
- *
- * @example
- * createDate(2022, 11, 13);
- * // => 2022-12-13T00:00:00.000Z
- *
- * @example
- * createDate('2022-12-13T00:00:00.000Z');
- * // => 2022-12-13T00:00:00.000Z
- */
-export declare const createDate: (yearOrIsoString?: number | string, month?: number, day?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number) => Date;
-/**
- *
- * @param date
- * @param duration
- * @returns {Date} the new Date
- */
-export declare const add: (date: Date | number, duration: Duration) => Date;
-/**
- *
- * @param date
- * @param duration
- * @returns {Date} the new Date
- */
-export declare const sub: (date: Date | number, duration: Duration) => Date;
-/**
- * Finds the number of years between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of minutes
- */
-export declare const differenceInYears: (dateLeft: Date | number, dateRight: Date | number) => number;
-/**
- * Finds the number of months between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of minutes
- */
-export declare const differenceInMonths: (dateLeft: Date | number | string, dateRight: Date | number | string) => number;
-/**
- * Finds the number of days between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of minutes
- */
-export declare const differenceInDays: (dateLeft: Date | number | string, dateRight: Date | number | string) => number;
-/**
- * Finds the number of minuts between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of minutes
- */
-export declare const differenceInMinutes: (dateLeft: Date | number, dateRight: Date | number) => number;
-/**
- * Finds the number of hours between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of hours
- */
-export declare const differenceInHours: (dateLeft: Date | number, dateRight: Date | number, roundingMethod?: 'ceil' | 'floor' | 'round' | 'trunc') => number;
-/**
- * Finds the number of seconds between to dates
- *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns {number} the number of minutes
- */
-export declare const differenceInSeconds: (dateLeft: Date | number, dateRight: Date | number) => number;
-/**
- *
- * @param date - the date to be rounded
- * @param options - the options for rounding
- * @returns the new date
- */
-export declare const roundToNearestMinutes: (date: Date | number, options: {
-    nearestTo: NearestMinutes;
-}) => Date;
-/**
- *
- * @param date - the date that should be before the other one to return true
- * @param dateToCompare -the date to compare with
- *
- * @returns the first date is before the second date
- */
-export declare const isBefore: (date: Date | number, dateToCompare: Date | number) => boolean;
-/**
- *
- * @param date - the date that should be after the other one to return true
- * @param dateToCompare -the date to compare with
- *
- * @returns the first date is after the second date
- */
-export declare const isAfter: (date: Date | number, dateToCompare: Date | number) => boolean;
-/**
- * Gracefully parsing string to a date, setting tz to UTC even if it's missing or input is invalid
- * Note: use getUtcFromString() to convert a string to a date with stricter returns
- * @param dateStr - string containing date
- * @returns {Date} - Date in UTC, or current date when something invalid is passed.
- */
-export declare const utc: (dateStr?: string | undefined) => Date;
-/**
- * Parsing string to a date. Stricter check, will return undefined when dateString is invalid.
- * @param dateStr - string containing date
- * @returns {Date} - Date in UTC, undefined when not valid
- */
-export declare const getUtcFromString: (dateStr: string | undefined | null) => Date | undefined;
-/**
- * Check if a date object is valid
- * @param {Date | number} date - date to be checked
- * @returns {boolean} - True if valid
- */
-export declare const isValid: (date: Date | number) => boolean;
-/**
- * Get the seconds timestamp of the given date
- * @param {Date} date - the given date
- * @returns the timestamp
- */
-export declare const unix: (date: Date | number) => number;
-/**
- * Return the Date object for a given timestamp
- * @param {number} unixTime - timestamp
- * @returns the timestamp
- */
-export declare const fromUnix: (unixTime: number) => Date;
-export declare const parseCustomDateString: (dateStr: string) => Date;
-/**
- * Returns Date in UTC
- * @returns {Date} - Date in UTC
- */
-export declare const getNowUtc: () => Date;
-/**
- * Returns current time as string
- * @param {string} strFormat - [default: "yyyy-MM-dd'T'HH:mm:ss'Z'"] format of string
- * @param {boolean} utc - [default: true] true to return in utc otherwise return in local timezone
- *
- * @returns {string} - formatted date string
- */
-export declare const getCurrentTimeAsString: (strFormat?: string, utc?: boolean) => string;
-/**
- * Set date values to a given date (by default it is assumed you are passing the new values in UTC).
- * Note that months start at 0!
- * @param date - the dater to be changed
- * @param values - an object with options
- * @param useLocalTimeZone - boolean true if you are passing the values in local timezone
- * @returns the new date with options set
- */
-export declare const set: (date: Date, values: DateValues, useLocalTimeZone?: boolean) => Date;
-/**
- * Get hours of a passed date in UTC (or local timezone if passed false)
- * @param date - the date of which to extract hours
- * @param utc - boolean true - whether to get UTC hours
- * @returns the hour number
- */
-export declare const getHours: (date: Date, utc?: boolean) => number;
-/**
- * Return the start of hour for the given date. The result will be in UTC.
- * @param date - the date of which to retrieve the start of the hour
- * @returns the new date
- */
-export declare const startOfHourUTC: (date: Date) => Date;
-/**
- * Return the start of a day for the given date. The result will be in UTC.
- * @param date - the date of which to retrieve the start of day
- * @returns the new date
- */
-export declare const startOfDayUTC: (date: Date) => Date;
-/**
- * Return the start of a week for the given date. The result will be in UTC.
- * @param date - the date of which to retrieve the start of the week
- * @returns the new date
- */
-export declare const startOfWeekUTC: (date: Date) => Date;
-/**
- * Return the start of a month for the given date. The result will be in UTC.
- * @param date - the date of which to retrieve the start of the month
- * @returns the new date
- */
-export declare const startOfMonthUTC: (date: Date) => Date;
-/**
- * Return the start of a year for the given date. The result will be in UTC.
- * @param date - the date of which to retrieve the start of the year
- * @returns the new date
- */
-export declare const startOfYearUTC: (date: Date) => Date;
-/**
- * Parse custom time format of NOW+current time | current date in UTC. The result will be in UTC.
- * @param timeValue - string value
- * @returns Time in UTC format
- */
-export declare const convertNOWFormatToUTC: (timeValue: string) => string;
-/**
- * Parse custom time format of NOW+-hours and minutes || TODAY+-hours and minutes into UTC. The result will be in UTC.
- * @param timeValue - string value
- * @returns Time in UTC format
- */
-export declare const convertNOWandTODAYFormatsToUTC: (timeValue: string) => string;
-/**
- * Compares two dates if values are the same
- * @param {Date} date - first date
- * @param {Date} date - second date
- * @returns {boolean} - True if dates are equal
- */
-export { isEqual, startOfDay, parseISO, isWithinInterval, getDayOfYear, getDay, getMonth, getYear, getWeek, };
+import { parseISO, isEqual, Duration, startOfDay, isWithinInterval, getDayOfYear, getDay, getMonth, getYear, getWeek, NearestMinutes } from 'date-fns';
+export interface DateValues {
+    year?: number;
+    month?: number;
+    date?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+    milliseconds?: number;
+}
+/**
+ * Parsing date strings with geoweb dateUtils:
+ *
+ * An ISO String *with timezone* can safely be parsed directly to a date:
+ *
+ * date = new Date('2022-10-10T15:30:00Z')
+ * date = new Date('2022-10-10T15:30:00+00:00')
+ * date = new Date('2022-10-10T15:30:00+02:00')
+ *
+ * or using the dateUtils isoStringToDate function *with utc=false*
+ *
+ * date = isoStringToDate('2022-10-10T15:30:00Z', false)
+ *
+ * An ISO String *without a timezone* can be parsed with isoStringToDate
+ *
+ * date = isoStringToDate('2022-10-10T15:30:00')
+ *
+ * *Do not parse ISO without timezone using `new Date()` unless you correct for the local timezone*
+ *
+ * To parse an arbitrary date string with timezone use:
+ *
+ * date = stringToDate('2022.11.10, 11:15 +01:00', 'yyyy.MM.dd, HH:mm xxx', false)
+ *
+ * To parse an arbitrary date string without timezone use:
+ *
+ * date = stringToDate('2022.11.10, 11:15', 'yyyy.MM.dd, HH:mm')
+ *
+ *
+ * To safely convert dates to utc strings use:
+ *
+ * date.toISOString()
+ *
+ * To get parts of UTC time use
+ *
+ * date.getUTCHours()
+ * date.getUTCMins()
+ *
+ * To parse an arbitrary date string to a UTC string use:
+ *
+ * dateToString(new Date('2022-10-10T15:30:00Z'), 'HH:ss dd MMM yyyy')
+ *
+ */
+/**
+ * Parse an ISO string to a date
+ *
+ * Expects the following props:
+ * @param {string} input - string containing date
+ *
+ * @returns {Date} Date
+ * @example
+ * ``` isoStringToDate("2022-5-10T20:32:00+00:00") ```
+ * ``` isoStringToDate("2022-5-10T20:32:00:00Z", false) ```
+ */
+export declare const isoStringToDate: (input: string, utc?: boolean) => Date | undefined;
+export declare const isValidIsoDateString: (input: string) => boolean;
+/**
+ * Parse a string to a date
+ *
+ * ***NOTE: String will be parsed in local time if utc is set to false***
+ *
+ * Expects the following props:
+ * @param {string} input - string containing date
+ * @param {string} strFormat - format of the string, see: https://date-fns.org/v2.29.3/docs/parse
+ * @param {boolean} utc [ default = true ] - boolean indicating whether to parse as UTC
+ * @param {Date} referenceDate [ default = new Date() ] - defines values missing from the parsed dateString
+ *
+ * @returns {Date} Date
+ * @example
+ * ``` stringToDate("2022 5 10 20:32", 'yyyy M d HH:mm')) ```
+ */
+export declare const stringToDate: (input: string | undefined, strFormat: string, utc?: boolean, referenceDate?: Date | number) => Date | undefined;
+export declare const dateToIsoString: (input: Date | undefined) => string | undefined;
+/**
+ * Use this if you initialise a date without a timezone to set it to utc correctly
+ * eg.
+ *   new Date(2022, 10, 12, 15, 30)
+ * should be:
+ *   setUTCDate(new Date(2022, 10, 12, 15, 30))
+ *
+ * Expects the following props:
+ * @param {Date} inDate - date to be set to UTC
+ *
+ * @returns {Date} - Date in UTC
+ * @example
+ * ``` setUTCDate(new Date(2022, 10, 12, 15, 30)) ```
+ */
+export declare const setUTCDate: (inDate: Date | undefined) => Date | undefined;
+/**
+ * Format a date to a string
+ *
+ * Expects the following props:
+ * @param {Date} inDate - date to be formatted
+ * @param {string} strFormat - [default: "yyyy-MM-dd'T'HH:mm:ss'Z'"] format of string
+ * @param {boolean} utc - [default: true] true to return in utc otherwise return in local timezone
+ *
+ * @returns {string} - formatted date string
+ * @example
+ * ``` dateToString(new Date(2022, 10, 12, 15, 30), 'dd MMM yyyy') ```
+ */
+export declare const dateToString: (inDate: Date | undefined, strFormat?: string, utc?: boolean) => string | undefined;
+/**
+ * Find out if a date is between two other dates.
+ *
+ * Inclusivity parameter matches that used in momentjs where '[' indicates inclusion and '(' indicates exclusion.
+ *
+ * Expects the following props:
+ * @param {Date} date - date to be tested
+ * @param {Date} from - first date
+ * @param {Date} to - last date
+ * @param {string} inclusivity - [default: '()'] Must be one of : '()', '[]', '(]', '[)'
+ *
+ * @returns {boolen} - true if date is between, otherwise false
+ *
+ */
+export declare const isBetween: (date: Date, from: Date, to: Date, inclusivity?: string) => boolean;
+/**
+ * Creates a new Date object with the specified date and time, or the current date and time if no arguments are provided.
+ *
+ * @param yearOrIsoString The year for the new Date object, or an ISO-formatted string representing the date and time.
+ * @param month The month for the new Date object (0-11).
+ * @param day The day for the new Date object (1-31).
+ * @param hours The hour for the new Date object (0-23).
+ * @param minutes The minute for the new Date object (0-59).
+ * @param seconds The second for the new Date object (0-59).
+ * @param milliseconds The millisecond for the new Date object (0-999).
+ * @returns A new Date object with the specified date and time, or the current date and time if no arguments are provided.
+ *
+ * @example
+ * createDate(2022, 11, 13);
+ * // => 2022-12-13T00:00:00.000Z
+ *
+ * @example
+ * createDate('2022-12-13T00:00:00.000Z');
+ * // => 2022-12-13T00:00:00.000Z
+ */
+export declare const createDate: (yearOrIsoString?: number | string, month?: number, day?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number) => Date;
+/**
+ *
+ * @param date
+ * @param duration
+ * @returns {Date} the new Date
+ */
+export declare const add: (date: Date | number, duration: Duration) => Date;
+/**
+ *
+ * @param date
+ * @param duration
+ * @returns {Date} the new Date
+ */
+export declare const sub: (date: Date | number, duration: Duration) => Date;
+/**
+ * Finds the number of years between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of minutes
+ */
+export declare const differenceInYears: (dateLeft: Date | number, dateRight: Date | number) => number;
+/**
+ * Finds the number of months between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of minutes
+ */
+export declare const differenceInMonths: (dateLeft: Date | number | string, dateRight: Date | number | string) => number;
+/**
+ * Finds the number of days between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of minutes
+ */
+export declare const differenceInDays: (dateLeft: Date | number | string, dateRight: Date | number | string) => number;
+/**
+ * Finds the number of minuts between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of minutes
+ */
+export declare const differenceInMinutes: (dateLeft: Date | number, dateRight: Date | number) => number;
+/**
+ * Finds the number of hours between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of hours
+ */
+export declare const differenceInHours: (dateLeft: Date | number, dateRight: Date | number, roundingMethod?: 'ceil' | 'floor' | 'round' | 'trunc') => number;
+/**
+ * Finds the number of seconds between to dates
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns {number} the number of minutes
+ */
+export declare const differenceInSeconds: (dateLeft: Date | number, dateRight: Date | number) => number;
+/**
+ *
+ * @param date - the date to be rounded
+ * @param options - the options for rounding
+ * @returns the new date
+ */
+export declare const roundToNearestMinutes: (date: Date | number, options: {
+    nearestTo: NearestMinutes;
+}) => Date;
+/**
+ *
+ * @param date - the date that should be before the other one to return true
+ * @param dateToCompare -the date to compare with
+ *
+ * @returns the first date is before the second date
+ */
+export declare const isBefore: (date: Date | number, dateToCompare: Date | number) => boolean;
+/**
+ *
+ * @param date - the date that should be after the other one to return true
+ * @param dateToCompare -the date to compare with
+ *
+ * @returns the first date is after the second date
+ */
+export declare const isAfter: (date: Date | number, dateToCompare: Date | number) => boolean;
+/**
+ * Gracefully parsing string to a date, setting tz to UTC even if it's missing or input is invalid
+ * Note: use getUtcFromString() to convert a string to a date with stricter returns
+ * @param dateStr - string containing date
+ * @returns {Date} - Date in UTC, or current date when something invalid is passed.
+ */
+export declare const utc: (dateStr?: string | undefined) => Date;
+/**
+ * Parsing string to a date. Stricter check, will return undefined when dateString is invalid.
+ * @param dateStr - string containing date
+ * @returns {Date} - Date in UTC, undefined when not valid
+ */
+export declare const getUtcFromString: (dateStr: string | undefined | null) => Date | undefined;
+/**
+ * Check if a date object is valid
+ * @param {Date | number} date - date to be checked
+ * @returns {boolean} - True if valid
+ */
+export declare const isValid: (date: Date | number) => boolean;
+/**
+ * Get the seconds timestamp of the given date
+ * @param {Date} date - the given date
+ * @returns the timestamp
+ */
+export declare const unix: (date: Date | number) => number;
+/**
+ * Return the Date object for a given timestamp
+ * @param {number} unixTime - timestamp
+ * @returns the timestamp
+ */
+export declare const fromUnix: (unixTime: number) => Date;
+export declare const parseCustomDateString: (dateStr: string) => Date;
+/**
+ * Returns Date in UTC
+ * @returns {Date} - Date in UTC
+ */
+export declare const getNowUtc: () => Date;
+/**
+ * Returns current time as string
+ * @param {string} strFormat - [default: "yyyy-MM-dd'T'HH:mm:ss'Z'"] format of string
+ * @param {boolean} utc - [default: true] true to return in utc otherwise return in local timezone
+ *
+ * @returns {string} - formatted date string
+ */
+export declare const getCurrentTimeAsString: (strFormat?: string, utc?: boolean) => string;
+/**
+ * Set date values to a given date (by default it is assumed you are passing the new values in UTC).
+ * Note that months start at 0!
+ * @param date - the dater to be changed
+ * @param values - an object with options
+ * @param useLocalTimeZone - boolean true if you are passing the values in local timezone
+ * @returns the new date with options set
+ */
+export declare const set: (date: Date, values: DateValues, useLocalTimeZone?: boolean) => Date;
+/**
+ * Get hours of a passed date in UTC (or local timezone if passed false)
+ * @param date - the date of which to extract hours
+ * @param utc - boolean true - whether to get UTC hours
+ * @returns the hour number
+ */
+export declare const getHours: (date: Date, utc?: boolean) => number;
+/**
+ * Return the start of hour for the given date. The result will be in UTC.
+ * @param date - the date of which to retrieve the start of the hour
+ * @returns the new date
+ */
+export declare const startOfHourUTC: (date: Date) => Date;
+/**
+ * Return the start of a day for the given date. The result will be in UTC.
+ * @param date - the date of which to retrieve the start of day
+ * @returns the new date
+ */
+export declare const startOfDayUTC: (date: Date) => Date;
+/**
+ * Return the start of a week for the given date. The result will be in UTC.
+ * @param date - the date of which to retrieve the start of the week
+ * @returns the new date
+ */
+export declare const startOfWeekUTC: (date: Date) => Date;
+/**
+ * Return the start of a month for the given date. The result will be in UTC.
+ * @param date - the date of which to retrieve the start of the month
+ * @returns the new date
+ */
+export declare const startOfMonthUTC: (date: Date) => Date;
+/**
+ * Return the start of a year for the given date. The result will be in UTC.
+ * @param date - the date of which to retrieve the start of the year
+ * @returns the new date
+ */
+export declare const startOfYearUTC: (date: Date) => Date;
+/**
+ * Parse custom time format of NOW+current time | current date in UTC. The result will be in UTC.
+ * @param timeValue - string value
+ * @returns Time in UTC format
+ */
+export declare const convertNOWFormatToUTC: (timeValue: string) => string;
+/**
+ * Parse custom time format of NOW+-hours and minutes || TODAY+-hours and minutes into UTC. The result will be in UTC.
+ * @param timeValue - string value
+ * @returns Time in UTC format
+ */
+export declare const convertNOWandTODAYFormatsToUTC: (timeValue: string) => string;
+/**
+ * Compares two dates if values are the same
+ * @param {Date} date - first date
+ * @param {Date} date - second date
+ * @returns {boolean} - True if dates are equal
+ */
+export { isEqual, startOfDay, parseISO, isWithinInterval, getDayOfYear, getDay, getMonth, getYear, getWeek, };