Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/date_fns/index.js.flow

date-fns Deno package
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653
// @flow// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
export type Interval = { start: Date | number, end: Date | number}
export type Locale = { formatDistance: Function, formatRelative: Function, localize: { ordinalNumber: Function, era: Function, quarter: Function, month: Function, day: Function, dayPeriod: Function }, formatLong: Object, date: Function, time: Function, dateTime: Function, match: { ordinalNumber: Function, era: Function, quarter: Function, month: Function, day: Function, dayPeriod: Function }, options?: { weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 }}
declare module.exports: { addBusinessDays: (date: Date | number, amount: number) => Date, addDays: (date: Date | number, amount: number) => Date, addHours: (date: Date | number, amount: number) => Date, addISOWeekYears: (date: Date | number, amount: number) => Date, addMilliseconds: (date: Date | number, amount: number) => Date, addMinutes: (date: Date | number, amount: number) => Date, addMonths: (date: Date | number, amount: number) => Date, addQuarters: (date: Date | number, amount: number) => Date, addSeconds: (date: Date | number, amount: number) => Date, addWeeks: (date: Date | number, amount: number) => Date, addYears: (date: Date | number, amount: number) => Date, areIntervalsOverlapping: ( intervalLeft: Interval, intervalRight: Interval ) => boolean, closestIndexTo: ( dateToCompare: Date | number, datesArray: (Date | number)[] ) => number, closestTo: ( dateToCompare: Date | number, datesArray: (Date | number)[] ) => Date, compareAsc: (dateLeft: Date | number, dateRight: Date | number) => number, compareDesc: (dateLeft: Date | number, dateRight: Date | number) => number, differenceInBusinessDays: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarDays: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarISOWeeks: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarISOWeekYears: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarMonths: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarQuarters: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInCalendarWeeks: ( dateLeft: Date | number, dateRight: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => number, differenceInCalendarYears: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInDays: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInHours: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInISOWeekYears: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInMilliseconds: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInMinutes: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInMonths: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInQuarters: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInSeconds: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInWeeks: ( dateLeft: Date | number, dateRight: Date | number ) => number, differenceInYears: ( dateLeft: Date | number, dateRight: Date | number ) => number, eachDayOfInterval: ( interval: Interval, options?: { step?: number } ) => Date[], eachWeekendOfInterval: (interval: Interval) => Date[], eachWeekendOfMonth: (date: Date | number) => Date[], eachWeekendOfYear: (date: Date | number) => Date[], eachWeekOfInterval: ( interval: Interval, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => Date[], endOfDay: (date: Date | number) => Date, endOfDecade: ( date: Date | number, options?: { additionalDigits?: 0 | 1 | 2 } ) => Date, endOfHour: (date: Date | number) => Date, endOfISOWeek: (date: Date | number) => Date, endOfISOWeekYear: (date: Date | number) => Date, endOfMinute: (date: Date | number) => Date, endOfMonth: (date: Date | number) => Date, endOfQuarter: (date: Date | number) => Date, endOfSecond: (date: Date | number) => Date, endOfToday: () => Date, endOfTomorrow: () => Date, endOfWeek: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => Date, endOfYear: (date: Date | number) => Date, endOfYesterday: () => Date, format: ( date: Date | number, format: string, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: number, useAdditionalWeekYearTokens?: boolean, useAdditionalDayOfYearTokens?: boolean } ) => string, formatDistance: ( date: Date | number, baseDate: Date | number, options?: { includeSeconds?: boolean, addSuffix?: boolean, locale?: Locale } ) => string, formatDistanceStrict: ( date: Date | number, baseDate: Date | number, options?: { addSuffix?: boolean, unit?: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year', roundingMethod?: 'floor' | 'ceil' | 'round', locale?: Locale } ) => string, formatDistanceToNow: ( date: Date | number, options?: { includeSeconds?: boolean, addSuffix?: boolean, locale?: Locale } ) => string, formatRelative: ( date: Date | number, baseDate: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => string, fromUnixTime: (unixTime: number) => Date, getDate: (date: Date | number) => number, getDay: (date: Date | number) => number, getDayOfYear: (date: Date | number) => number, getDaysInMonth: (date: Date | number) => number, getDaysInYear: (date: Date | number) => number, getDecade: (date: Date | number) => number, getHours: (date: Date | number) => number, getISODay: (date: Date | number) => number, getISOWeek: (date: Date | number) => number, getISOWeeksInYear: (date: Date | number) => number, getISOWeekYear: (date: Date | number) => number, getMilliseconds: (date: Date | number) => number, getMinutes: (date: Date | number) => number, getMonth: (date: Date | number) => number, getOverlappingDaysInIntervals: ( intervalLeft: Interval, intervalRight: Interval ) => number, getQuarter: (date: Date | number) => number, getSeconds: (date: Date | number) => number, getTime: (date: Date | number) => number, getUnixTime: (date: Date | number) => number, getWeek: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 } ) => number, getWeekOfMonth: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => number, getWeeksInMonth: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => number, getWeekYear: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 } ) => number, getYear: (date: Date | number) => number, isAfter: (date: Date | number, dateToCompare: Date | number) => boolean, isBefore: (date: Date | number, dateToCompare: Date | number) => boolean, isDate: (value: any) => boolean, isEqual: (dateLeft: Date | number, dateRight: Date | number) => boolean, isFirstDayOfMonth: (date: Date | number) => boolean, isFriday: (date: Date | number) => boolean, isFuture: (date: Date | number) => boolean, isLastDayOfMonth: (date: Date | number) => boolean, isLeapYear: (date: Date | number) => boolean, isMonday: (date: Date | number) => boolean, isPast: (date: Date | number) => boolean, isSameDay: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameHour: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameISOWeek: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameISOWeekYear: ( dateLeft: Date | number, dateRight: Date | number ) => boolean, isSameMinute: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameMonth: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameQuarter: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameSecond: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSameWeek: ( dateLeft: Date | number, dateRight: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => boolean, isSameYear: (dateLeft: Date | number, dateRight: Date | number) => boolean, isSaturday: (date: Date | number) => boolean, isSunday: (date: Date | number) => boolean, isThisHour: (date: Date | number) => boolean, isThisISOWeek: (date: Date | number) => boolean, isThisMinute: (date: Date | number) => boolean, isThisMonth: (date: Date | number) => boolean, isThisQuarter: (date: Date | number) => boolean, isThisSecond: (date: Date | number) => boolean, isThisWeek: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => boolean, isThisYear: (date: Date | number) => boolean, isThursday: (date: Date | number) => boolean, isToday: (date: Date | number) => boolean, isTomorrow: (date: Date | number) => boolean, isTuesday: (date: Date | number) => boolean, isValid: (date: any) => boolean, isWednesday: (date: Date | number) => boolean, isWeekend: (date: Date | number) => boolean, isWithinInterval: (date: Date | number, interval: Interval) => boolean, isYesterday: (date: Date | number) => boolean, lastDayOfDecade: (date: Date | number) => Date, lastDayOfISOWeek: (date: Date | number) => Date, lastDayOfISOWeekYear: (date: Date | number) => Date, lastDayOfMonth: (date: Date | number) => Date, lastDayOfQuarter: ( date: Date | number, options?: { additionalDigits?: 0 | 1 | 2 } ) => Date, lastDayOfWeek: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => Date, lastDayOfYear: (date: Date | number) => Date, lightFormat: (date: Date | number, format: string) => string, max: (datesArray: (Date | number)[]) => Date, min: (datesArray: (Date | number)[]) => Date, parse: ( dateString: string, formatString: string, backupDate: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7, useAdditionalWeekYearTokens?: boolean, useAdditionalDayOfYearTokens?: boolean } ) => Date, parseISO: ( argument: string, options?: { additionalDigits?: 0 | 1 | 2 } ) => Date, roundToNearestMinutes: ( date: Date | number, options?: { nearestTo?: number } ) => Date, set: ( date: Date | number, values: { year?: number, month?: number, date?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number } ) => Date, setDate: (date: Date | number, dayOfMonth: number) => Date, setDay: ( date: Date | number, day: number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => Date, setDayOfYear: (date: Date | number, dayOfYear: number) => Date, setHours: (date: Date | number, hours: number) => Date, setISODay: (date: Date | number, day: number) => Date, setISOWeek: (date: Date | number, isoWeek: number) => Date, setISOWeekYear: (date: Date | number, isoWeekYear: number) => Date, setMilliseconds: (date: Date | number, milliseconds: number) => Date, setMinutes: (date: Date | number, minutes: number) => Date, setMonth: (date: Date | number, month: number) => Date, setQuarter: (date: Date | number, quarter: number) => Date, setSeconds: (date: Date | number, seconds: number) => Date, setWeek: ( date: Date | number, week: number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 } ) => Date, setWeekYear: ( date: Date | number, weekYear: number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 } ) => Date, setYear: (date: Date | number, year: number) => Date, startOfDay: (date: Date | number) => Date, startOfDecade: (date: Date | number) => Date, startOfHour: (date: Date | number) => Date, startOfISOWeek: (date: Date | number) => Date, startOfISOWeekYear: (date: Date | number) => Date, startOfMinute: (date: Date | number) => Date, startOfMonth: (date: Date | number) => Date, startOfQuarter: (date: Date | number) => Date, startOfSecond: (date: Date | number) => Date, startOfToday: () => Date, startOfTomorrow: () => Date, startOfWeek: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 } ) => Date, startOfWeekYear: ( date: Date | number, options?: { locale?: Locale, weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7 } ) => Date, startOfYear: (date: Date | number) => Date, startOfYesterday: () => Date, subDays: (date: Date | number, amount: number) => Date, subHours: (date: Date | number, amount: number) => Date, subISOWeekYears: (date: Date | number, amount: number) => Date, subMilliseconds: (date: Date | number, amount: number) => Date, subMinutes: (date: Date | number, amount: number) => Date, subMonths: (date: Date | number, amount: number) => Date, subQuarters: (date: Date | number, amount: number) => Date, subSeconds: (date: Date | number, amount: number) => Date, subWeeks: (date: Date | number, amount: number) => Date, subYears: (date: Date | number, amount: number) => Date, toDate: (argument: Date | number) => Date, maxTime: number, minTime: number}