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

x/date_fns/index.js.flow

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