@checkdigit/time 3.0.0-PR.17-58cd → 4.0.0-PR.18-9134

package/dist-types/date-fns/locale/types.d.ts

@@ -1,76 +1,212 @@
-import type { Day, Era, FirstWeekContainsDate, Month, Quarter, Unit } from '../types';
-import type { BuildLocalizeFnArgCallback, LocalizeUnitValues, LocalizeUnitValuesIndex } from './_lib/buildLocalizeFn';
+import type { Day, Era, FirstWeekContainsDateOptions, LocalizedOptions, Month, Quarter, WeekOptions } from "../types";
+/**
+ * The locale object with all functions and data needed to parse and format
+ * dates. This is what each locale implements and exports.
+ */
 export interface Locale {
+    /** The locale code (ISO 639-1 + optional country code) */
     code: string;
+    /** The function to format distance */
     formatDistance: FormatDistanceFn;
+    /** The function to relative time */
     formatRelative: FormatRelativeFn;
+    /** The object with functions used to localize various values */
     localize: Localize;
+    /** The object with functions that return localized formats */
     formatLong: FormatLong;
+    /** The object with functions used to match and parse various localized values */
     match: Match;
+    /** An object with locale options */
     options?: LocaleOptions;
 }
-export interface LocaleOptions {
-    weekStartsOn?: Day;
-    firstWeekContainsDate?: FirstWeekContainsDate;
+/**
+ * The locale options.
+ */
+export interface LocaleOptions extends WeekOptions, FirstWeekContainsDateOptions {
 }
-export type FormatDistanceToken = 'lessThanXSeconds' | 'xSeconds' | 'halfAMinute' | 'lessThanXMinutes' | 'xMinutes' | 'aboutXHours' | 'xHours' | 'xDays' | 'aboutXWeeks' | 'xWeeks' | 'aboutXMonths' | 'xMonths' | 'aboutXYears' | 'xYears' | 'overXYears' | 'almostXYears';
-export type FormatDistanceLocale<Value> = {
-    [token in FormatDistanceToken]: Value;
-};
+/**
+ * The function that takes a token (i.e. halfAMinute) passed by `formatDistance`
+ * or `formatDistanceStrict` and payload, and returns localized distance.
+ *
+ * @param token - The token to localize
+ * @param count - The distance number
+ * @param options - The object with options
+ *
+ * @returns The localized distance in words
+ */
+export type FormatDistanceFn = (token: FormatDistanceToken, count: number, options?: FormatDistanceFnOptions) => string;
+/**
+ * The {@link FormatDistanceFn} function options.
+ */
 export interface FormatDistanceFnOptions {
+    /** Add "X ago"/"in X" in the locale language */
     addSuffix?: boolean;
+    /** The distance vector. -1 represents past and 1 future. Tells which suffix
+     * to use. */
     comparison?: -1 | 0 | 1;
 }
-export type FormatDistanceTokenFn = (count: number, options?: FormatDistanceFnOptions) => string;
-export interface FormatDistanceFnOptions {
-    addSuffix?: boolean;
-    comparison?: -1 | 0 | 1;
+/**
+ * The function used inside the {@link FormatDistanceFn} function, implementing
+ * formatting for a particular token.
+ */
+export type FormatDistanceTokenFn = (
+/** The distance as number to format */
+count: number, 
+/** The object with options */
+options?: FormatDistanceFnOptions) => string;
+/**
+ * The tokens map to string templates used in the format distance function.
+ * It looks like this:
+ *
+ *   const formatDistanceLocale: FormatDistanceLocale<FormatDistanceTokenValue> = {
+ *     lessThanXSeconds: 'តិចជាង {{count}} វិនាទី',
+ *     xSeconds: '{{count}} វិនាទី',
+ *     // ...
+ *   }
+ *
+ * @typeParam Template - The property value type.
+ */
+export type FormatDistanceLocale<Template> = {
+    [Token in FormatDistanceToken]: Template;
+};
+/**
+ * The token used in the format distance function. Represents the distance unit
+ * with prespecified precision.
+ */
+export type FormatDistanceToken = "lessThanXSeconds" | "xSeconds" | "halfAMinute" | "lessThanXMinutes" | "xMinutes" | "aboutXHours" | "xHours" | "xDays" | "aboutXWeeks" | "xWeeks" | "aboutXMonths" | "xMonths" | "aboutXYears" | "xYears" | "overXYears" | "almostXYears";
+/**
+ * The locale function that does the work for the `formatRelative` function.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param token - The token to localize
+ * @param date - The date to format
+ * @param baseDate - The date to compare with
+ * @param options - The object with options
+ *
+ * @returns The localized relative date format
+ */
+export type FormatRelativeFn = <DateType extends Date>(token: FormatRelativeToken, date: DateType, baseDate: DateType, options?: FormatRelativeFnOptions) => string;
+/**
+ * The {@link FormatRelativeFn} function options.
+ */
+export interface FormatRelativeFnOptions extends WeekOptions, LocalizedOptions<"options" | "formatRelative"> {
 }
-export type FormatDistanceFn = (token: FormatDistanceToken, count: number, options?: FormatDistanceFnOptions) => string;
-export type FormatRelativeTokenFn = <DateType extends Date>(date: DateType | number, baseDate: DateType | number, options?: {
-    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
-}) => string;
-export type FormatRelativeToken = 'lastWeek' | 'yesterday' | 'today' | 'tomorrow' | 'nextWeek' | 'other';
-export interface FormatRelativeFnOptions {
-    weekStartsOn?: Day;
-    locale?: Locale;
+/**
+ * The locale function used inside the {@link FormatRelativeFn} function
+ * implementing formatting for a particular token.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The date to format
+ * @param baseDate - The date to compare with
+ * @param options - The object with options
+ */
+export type FormatRelativeTokenFn = <DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: FormatRelativeTokenFnOptions) => string;
+/**
+ * The {@link FormatRelativeTokenFn} function options.
+ */
+export interface FormatRelativeTokenFnOptions extends WeekOptions {
 }
-export type FormatRelativeFn = <DateType extends Date>(token: FormatRelativeToken, date: DateType, baseDate: DateType, options?: FormatRelativeFnOptions) => string;
-export type LocalizeUnitIndex<Unit extends LocaleUnit | number> = Unit extends LocaleUnit ? LocalizeUnitValuesIndex<LocalizeUnitValues<Unit>> : number;
-export type LocalizeFn<Result extends LocaleUnit | number, ArgCallback extends BuildLocalizeFnArgCallback<Result> | undefined = undefined> = (value: ArgCallback extends undefined ? Result : Result extends Quarter ? Quarter : LocalizeUnitIndex<Result>, options?: {
-    width?: LocalePatternWidth;
-    context?: 'formatting' | 'standalone';
-    unit?: Unit;
-}) => string;
+/**
+ * The token used in format relative function. Represents the time unit.
+ */
+export type FormatRelativeToken = "lastWeek" | "yesterday" | "today" | "tomorrow" | "nextWeek" | "other";
+/**
+ * A format part that represents a token or string literal, used by format parser/tokenizer
+ */
+export interface FormatPart {
+    /** If the part is a format token. */
+    isToken: boolean;
+    /** The format part value (i.e. `"do"`). */
+    value: string;
+}
+/**
+ * The object with functions used to localize various values. Part of the public
+ * locale API.
+ */
 export interface Localize {
-    ordinalNumber: LocalizeFn<number, BuildLocalizeFnArgCallback<number> | undefined>;
-    era: LocalizeFn<Era, undefined>;
-    quarter: LocalizeFn<Quarter, BuildLocalizeFnArgCallback<Quarter>>;
-    month: LocalizeFn<Month, undefined>;
-    day: LocalizeFn<Day, undefined>;
-    dayPeriod: LocalizeFn<LocaleDayPeriod, undefined>;
+    /** The function that localizes an ordinal number */
+    ordinalNumber: LocalizeFn<number>;
+    /** The function that localized the era */
+    era: LocalizeFn<Era>;
+    /** The function that localizes the quarter */
+    quarter: LocalizeFn<Quarter>;
+    /** The function that localizes the month */
+    month: LocalizeFn<Month>;
+    /** The function that localizes the day of the week */
+    day: LocalizeFn<Day>;
+    /** The function that localizes the day period */
+    dayPeriod: LocalizeFn<LocaleDayPeriod>;
+    /** The function that can preprocess parts/tokens **/
+    preprocessor?: <DateType extends Date>(date: DateType, parts: FormatPart[]) => FormatPart[];
 }
-export interface BuildMatchFnArgs<Result extends LocaleUnit, DefaultMatchWidth extends LocalePatternWidth, DefaultParseWidth extends LocalePatternWidth> {
-    matchPatterns: MatchPatterns<DefaultMatchWidth>;
-    defaultMatchWidth: DefaultMatchWidth;
-    parsePatterns: ParsePatterns<Result, DefaultParseWidth>;
-    defaultParseWidth: DefaultParseWidth;
-    valueCallback?: MatchValueCallback<Result extends LocaleDayPeriod ? string : number, Result>;
+/**
+ * Individual localize function. Part of {@link Localize}.
+ *
+ * @typeParam Value - The value type to localize.
+ *
+ * @param value - The value to localize
+ * @param options - The object with options
+ *
+ * @returns The localized string
+ */
+export type LocalizeFn<Value extends LocaleUnitValue | number> = (value: Value, options?: LocalizeFnOptions) => string;
+/**
+ * The {@link LocalizeFn} function options.
+ */
+export interface LocalizeFnOptions {
+    /** The width to use formatting the value, defines how short or long
+     * the formatted string might be. */
+    width?: LocaleWidth;
+    /** The context where the formatted value is used - standalone: the result
+     * should make grammatical sense as is and formatting: the result is a part
+     * of the formatted string. See: https://date-fns.org/docs/I18n-Contribution-Guide */
+    context?: "formatting" | "standalone";
+    /** The unit to format */
+    unit?: LocaleUnit;
 }
-export type MatchPatterns<DefaultWidth extends LocalePatternWidth> = {
-    [pattern in LocalePatternWidth]?: RegExp;
-} & {
-    [key in DefaultWidth]: RegExp;
-};
-export type ParsePatterns<Result extends LocaleUnit, DefaultWidth extends LocalePatternWidth> = {
-    [pattern in LocalePatternWidth]?: ParsePattern<Result>;
-} & {
-    [key in DefaultWidth]: ParsePattern<Result>;
-};
-export type ParsePattern<Result extends LocaleUnit> = Result extends LocaleDayPeriod ? Record<LocaleDayPeriod, RegExp> : Result extends Quarter ? readonly [RegExp, RegExp, RegExp, RegExp] : Result extends Era ? readonly [RegExp, RegExp] : Result extends Day ? readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp] : Result extends Month ? readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp] : never;
-export type BuildMatchFn<Result extends LocaleUnit, DefaultMatchWidth extends LocalePatternWidth, DefaultParseWidth extends LocalePatternWidth> = (args: BuildMatchFnArgs<Result, DefaultMatchWidth, DefaultParseWidth>) => MatchFn<Result>;
-export type MatchFn<Result, ExtraOptions = Record<string, unknown>> = (str: string, options?: {
-    width?: LocalePatternWidth;
+/**
+ * The object with functions used to match and parse various localized values.
+ */
+export interface Match {
+    /** The function that parses a localized ordinal number. */
+    ordinalNumber: MatchFn<number, {
+        unit: LocaleUnit;
+    }>;
+    /** The function that parses a localized era. */
+    era: MatchFn<Era>;
+    /** The function that parses a localized quarter. */
+    quarter: MatchFn<Quarter>;
+    /** The function that parses a localized month. */
+    month: MatchFn<Month>;
+    /** The function that parses a localized day of the week. */
+    day: MatchFn<Day>;
+    /** The function that parses a localized time of the day. */
+    dayPeriod: MatchFn<LocaleDayPeriod>;
+}
+/**
+ * The match function. Part of {@link Match}. Implements matcher for particular
+ * unit type.
+ *
+ * @typeParam Result - The matched value type.
+ * @typeParam ExtraOptions - The the extra options type.
+ *
+ * @param str - The string to match
+ * @param options - The object with options
+ *
+ * @returns The match result or null if match failed
+ */
+export type MatchFn<Result, ExtraOptions = Record<string, unknown>> = (str: string, options?: MatchFnOptions<Result> & ExtraOptions) => MatchFnResult<Result> | null;
+/**
+ * The {@link MatchFn} function options.
+ *
+ * @typeParam Result - The matched value type.
+ */
+export interface MatchFnOptions<Result> {
+    /** The width to use matching the value, defines how short or long
+     * the matched string might be. */
+    width?: LocaleWidth;
     /**
      * @deprecated Map the value manually instead.
      * @example
@@ -80,36 +216,76 @@ export type MatchFn<Result, ExtraOptions = Record<string, unknown>> = (str: stri
      * }
      */
     valueCallback?: MatchValueCallback<string, Result>;
-} & ExtraOptions) => {
+}
+/**
+ * The function that allows to map the matched value to the actual type.
+ *
+ * @typeParam Arg - The argument type.
+ * @typeParam Result - The matched value type.
+ *
+ * @param arg - The value to match
+ *
+ * @returns The matched value
+ */
+export type MatchValueCallback<Arg, Result> = (value: Arg) => Result;
+/**
+ * The {@link MatchFn} function result.
+ *
+ * @typeParam Result - The matched value type.
+ */
+export interface MatchFnResult<Result> {
+    /** The matched value parsed as the corresponding unit type */
     value: Result;
+    /** The remaining string after parsing */
     rest: string;
-} | null;
-export type MatchValueCallback<Arg, Result> = (value: Arg) => Result;
-export interface Match {
-    ordinalNumber: MatchFn<number, {
-        unit: LocaleOrdinalUnit;
-    }>;
-    era: MatchFn<Era>;
-    quarter: MatchFn<Quarter>;
-    month: MatchFn<Month>;
-    day: MatchFn<Day>;
-    dayPeriod: MatchFn<LocaleDayPeriod>;
 }
-export type LocaleOrdinalUnit = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'date' | 'dayOfYear';
-export type LocalePatternWidth = 'narrow' | 'short' | 'abbreviated' | 'wide' | 'any';
-export type LocaleDayPeriod = 'am' | 'pm' | 'midnight' | 'noon' | 'morning' | 'afternoon' | 'evening' | 'night';
-export type LocaleOptionUnit = 'year' | 'quarter' | 'month' | 'week' | 'date' | 'dayOfYear' | 'day' | 'hour' | 'minute' | 'second';
-export type FormatLongWidth = 'full' | 'long' | 'medium' | 'short' | 'any';
-export type DateTimeFormat = {
-    [format in FormatLongWidth]: string;
-};
-export type LocaleUnit = Era | Quarter | Month | Day | LocaleDayPeriod;
+/**
+ * The object with functions that return localized formats. Long stands for
+ * sequence of tokens (i.e. PPpp) that allows to define how format both date
+ * and time at once. Part of the public locale API.
+ */
 export interface FormatLong {
+    /** The function that returns a localized long date format */
     date: FormatLongFn;
+    /** The function that returns a localized long time format */
     time: FormatLongFn;
+    /** The function that returns a localized format of date and time combined */
     dateTime: FormatLongFn;
 }
+/**
+ * The format long function. Formats date, time or both.
+ *
+ * @param options - The object with options
+ *
+ * @returns The localized string
+ */
+export type FormatLongFn = (options: FormatLongFnOptions) => string;
+/**
+ * The {@link FormatLongFn} function options.
+ */
 export interface FormatLongFnOptions {
+    /** Format width to set */
     width?: FormatLongWidth;
 }
-export type FormatLongFn = (options: FormatLongFnOptions) => string;
+/**
+ * The format long width token, defines how short or long the formnatted value
+ * might be. The actual result length is defined by the locale.
+ */
+export type FormatLongWidth = "full" | "long" | "medium" | "short" | "any";
+/**
+ * The formatting unit value, represents the raw value that can be formatted.
+ */
+export type LocaleUnitValue = Era | Quarter | Month | Day | LocaleDayPeriod;
+/**
+ * The format width. Defines how short or long the formatted string might be.
+ * The actaul result length depends on the locale.
+ */
+export type LocaleWidth = "narrow" | "short" | "abbreviated" | "wide" | "any";
+/**
+ * Token representing particular period of the day.
+ */
+export type LocaleDayPeriod = "am" | "pm" | "midnight" | "noon" | "morning" | "afternoon" | "evening" | "night";
+/**
+ * The units commonly used in the date formatting or parsing.
+ */
+export type LocaleUnit = "second" | "minute" | "hour" | "day" | "dayOfYear" | "date" | "week" | "month" | "quarter" | "year";

package/dist-types/date-fns/max/index.d.ts

@@ -6,8 +6,11 @@
  * @description
  * Return the latest of the given dates.
  *
- * @param datesArray - the dates to compare
- * @returns the latest of the dates
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param dates - The dates to compare
+ *
+ * @returns The latest of the dates
  *
  * @example
  * // Which of these dates is the latest?
@@ -19,4 +22,4 @@
  * ])
  * //=> Sun Jul 02 1995 00:00:00
  */
-export default function max<DateType extends Date>(datesArray: Array<DateType | number>): DateType | Date;
+export declare function max<DateType extends Date>(dates: Array<DateType | number | string>): DateType | Date;

package/dist-types/date-fns/milliseconds/index.d.ts

@@ -1,4 +1,4 @@
-import type { Duration } from '../types';
+import type { Duration } from "../types";
 /**
  * @name milliseconds
  * @category Millisecond Helpers
@@ -15,8 +15,9 @@ import type { Duration } from '../types';
  *
  * One month is a year divided by 12.
  *
- * @param duration - the object with years, months, weeks, days, hours, minutes and seconds to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
- * @returns the milliseconds
+ * @param duration - The object with years, months, weeks, days, hours, minutes and seconds to be added.
+ *
+ * @returns The milliseconds
  *
  * @example
  * // 1 year in milliseconds
@@ -27,4 +28,4 @@ import type { Duration } from '../types';
  * milliseconds({ months: 3 })
  * //=> 7889238000
  */
-export default function milliseconds({ years, months, weeks, days, hours, minutes, seconds }: Duration): number;
+export declare function milliseconds({ years, months, weeks, days, hours, minutes, seconds, }: Duration): number;

package/dist-types/date-fns/millisecondsToHours/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of milliseconds to a full number of hours.
  *
- * @param milliseconds - number of milliseconds to be converted
+ * @param milliseconds - The number of milliseconds to be converted
  *
- * @returns the number of milliseconds converted in hours
+ * @returns The number of milliseconds converted in hours
  *
  * @example
  * // Convert 7200000 milliseconds to hours:
@@ -20,4 +20,4 @@
  * const result = millisecondsToHours(7199999)
  * //=> 1
  */
-export default function millisecondsToHours(milliseconds: number): number;
+export declare function millisecondsToHours(milliseconds: number): number;

package/dist-types/date-fns/millisecondsToMinutes/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of milliseconds to a full number of minutes.
  *
- * @param milliseconds - number of milliseconds to be converted.
+ * @param milliseconds - The number of milliseconds to be converted
  *
- * @returns the number of milliseconds converted in minutes
+ * @returns The number of milliseconds converted in minutes
  *
  * @example
  * // Convert 60000 milliseconds to minutes:
@@ -20,4 +20,4 @@
  * const result = millisecondsToMinutes(119999)
  * //=> 1
  */
-export default function millisecondsToMinutes(milliseconds: number): number;
+export declare function millisecondsToMinutes(milliseconds: number): number;

package/dist-types/date-fns/millisecondsToSeconds/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of milliseconds to a full number of seconds.
  *
- * @param milliseconds - number of milliseconds to be converted
+ * @param milliseconds - The number of milliseconds to be converted
  *
- * @returns the number of milliseconds converted in seconds
+ * @returns The number of milliseconds converted in seconds
  *
  * @example
  * // Convert 1000 miliseconds to seconds:
@@ -20,4 +20,4 @@
  * const result = millisecondsToSeconds(1999)
  * //=> 1
  */
-export default function millisecondsToSeconds(milliseconds: number): number;
+export declare function millisecondsToSeconds(milliseconds: number): number;

package/dist-types/date-fns/min/index.d.ts

@@ -6,8 +6,11 @@
  * @description
  * Returns the earliest of the given dates.
  *
- * @param datesArray - the dates to compare
- * @returns - the earliest of the dates
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param dates - The dates to compare
+ *
+ * @returns The earliest of the dates
  *
  * @example
  * // Which of these dates is the earliest?
@@ -19,4 +22,4 @@
  * ])
  * //=> Wed Feb 11 1987 00:00:00
  */
-export default function min<DateType extends Date>(datesArray: Array<DateType | number>): DateType | Date;
+export declare function min<DateType extends Date>(dates: Array<DateType | number | string>): DateType | Date;

package/dist-types/date-fns/minutesToHours/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of minutes to a full number of hours.
  *
- * @param minutes - number of minutes to be converted
+ * @param minutes - The number of minutes to be converted
  *
- * @returns the number of minutes converted in hours
+ * @returns The number of minutes converted in hours
  *
  * @example
  * // Convert 140 minutes to hours:
@@ -20,4 +20,4 @@
  * const result = minutesToHours(179)
  * //=> 2
  */
-export default function minutesToHours(minutes: number): number;
+export declare function minutesToHours(minutes: number): number;

package/dist-types/date-fns/minutesToMilliseconds/index.d.ts

@@ -6,13 +6,13 @@
  * @description
  * Convert a number of minutes to a full number of milliseconds.
  *
- * @param minutes - number of minutes to be converted
+ * @param minutes - The number of minutes to be converted
  *
- * @returns the number of minutes converted in milliseconds
+ * @returns The number of minutes converted in milliseconds
  *
  * @example
  * // Convert 2 minutes to milliseconds
  * const result = minutesToMilliseconds(2)
  * //=> 120000
  */
-export default function minutesToMilliseconds(minutes: number): number;
+export declare function minutesToMilliseconds(minutes: number): number;

package/dist-types/date-fns/minutesToSeconds/index.d.ts

@@ -6,13 +6,13 @@
  * @description
  * Convert a number of minutes to a full number of seconds.
  *
- * @param minutes - number of minutes to be converted
+ * @param minutes - The number of minutes to be converted
  *
- * @returns the number of minutes converted in seconds
+ * @returns The number of minutes converted in seconds
  *
  * @example
  * // Convert 2 minutes to seconds
  * const result = minutesToSeconds(2)
  * //=> 120
  */
-export default function minutesToSeconds(minutes: number): number;
+export declare function minutesToSeconds(minutes: number): number;

package/dist-types/date-fns/monthsToQuarters/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of months to a full number of quarters.
  *
- * @param months - number of months to be converted.
+ * @param months - The number of months to be converted.
  *
- * @returns the number of months converted in quarters
+ * @returns The number of months converted in quarters
  *
  * @example
  * // Convert 6 months to quarters:
@@ -20,4 +20,4 @@
  * const result = monthsToQuarters(7)
  * //=> 2
  */
-export default function monthsToQuarters(months: number): number;
+export declare function monthsToQuarters(months: number): number;

package/dist-types/date-fns/monthsToYears/index.d.ts

@@ -6,9 +6,9 @@
  * @description
  * Convert a number of months to a full number of years.
  *
- * @param months - number of months to be converted
+ * @param months - The number of months to be converted
  *
- * @returns the number of months converted in years
+ * @returns The number of months converted in years
  *
  * @example
  * // Convert 36 months to years:
@@ -19,4 +19,4 @@
  * const result = monthsToYears(40)
  * //=> 3
  */
-export default function monthsToYears(months: number): number;
+export declare function monthsToYears(months: number): number;

package/dist-types/date-fns/nextDay/index.d.ts

@@ -1,4 +1,4 @@
-import type { Day } from '../types';
+import type { Day } from "../types";
 /**
  * @name nextDay
  * @category Weekday Helpers
@@ -7,9 +7,12 @@ import type { Day } from '../types';
  * @description
  * When is the next day of the week? 0-6 the day of the week, 0 represents Sunday.
  *
- * @param date - the date to check
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The date to check
  * @param day - day of the week
- * @returns - the date is the next day of week
+ *
+ * @returns The date is the next day of week
  *
  * @example
  * // When is the next Monday after Mar, 20, 2020?
@@ -21,4 +24,4 @@ import type { Day } from '../types';
  * const result = nextDay(new Date(2020, 2, 21), 2)
  * //=> Tue Mar 24 2020 00:00:00
  */
-export default function nextDay<DateType extends Date>(date: DateType | number, day: Day): DateType;
+export declare function nextDay<DateType extends Date>(date: DateType | number | string, day: Day): DateType;

package/dist-types/date-fns/nextFriday/index.d.ts

@@ -6,12 +6,15 @@
  * @description
  * When is the next Friday?
  *
- * @param date - the date to start counting from
- * @returns the next Friday
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The date to start counting from
+ *
+ * @returns The next Friday
  *
  * @example
  * // When is the next Friday after Mar, 22, 2020?
  * const result = nextFriday(new Date(2020, 2, 22))
  * //=> Fri Mar 27 2020 00:00:00
  */
-export default function nextFriday<DateType extends Date>(date: DateType | number): DateType;
+export declare function nextFriday<DateType extends Date>(date: DateType | number | string): DateType;

package/dist-types/date-fns/nextMonday/index.d.ts

@@ -6,12 +6,15 @@
  * @description
  * When is the next Monday?
  *
- * @param date - the date to start counting from
- * @returns the next Monday
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The date to start counting from
+ *
+ * @returns The next Monday
  *
  * @example
  * // When is the next Monday after Mar, 22, 2020?
  * const result = nextMonday(new Date(2020, 2, 22))
  * //=> Mon Mar 23 2020 00:00:00
  */
-export default function nextMonday<DateType extends Date>(date: DateType | number): DateType;
+export declare function nextMonday<DateType extends Date>(date: DateType | number | string): DateType;