project files added
This commit is contained in:
+4
@@ -0,0 +1,4 @@
|
||||
// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
|
||||
|
||||
import { isThisWeek } from 'date-fns'
|
||||
export default isThisWeek
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
import isSameWeek from '../isSameWeek/index.js';
|
||||
/**
|
||||
* @name isThisWeek
|
||||
* @category Week Helpers
|
||||
* @summary Is the given date in the same week as the current date?
|
||||
* @pure false
|
||||
*
|
||||
* @description
|
||||
* Is the given date in the same week as the current date?
|
||||
*
|
||||
* > ⚠️ Please note that this function is not present in the FP submodule as
|
||||
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
||||
*
|
||||
* ### v2.0.0 breaking changes:
|
||||
*
|
||||
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||||
*
|
||||
* @param {Date|Number} date - the date to check
|
||||
* @param {Object} [options] - the object with options
|
||||
* @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
|
||||
* @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
|
||||
* @returns {Boolean} the date is in this week
|
||||
* @throws {TypeError} 1 argument required
|
||||
* @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
|
||||
*
|
||||
* @example
|
||||
* // If today is 25 September 2014, is 21 September 2014 in this week?
|
||||
* var result = isThisWeek(new Date(2014, 8, 21))
|
||||
* //=> true
|
||||
*
|
||||
* @example
|
||||
* // If today is 25 September 2014 and week starts with Monday
|
||||
* // is 21 September 2014 in this week?
|
||||
* var result = isThisWeek(new Date(2014, 8, 21), { weekStartsOn: 1 })
|
||||
* //=> false
|
||||
*/
|
||||
|
||||
export default function isThisWeek(dirtyDate, options) {
|
||||
if (arguments.length < 1) {
|
||||
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||||
}
|
||||
|
||||
return isSameWeek(dirtyDate, Date.now(), options);
|
||||
}
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
// @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: (...args: Array<any>) => any,
|
||||
formatRelative: (...args: Array<any>) => any,
|
||||
localize: {
|
||||
ordinalNumber: (...args: Array<any>) => any,
|
||||
era: (...args: Array<any>) => any,
|
||||
quarter: (...args: Array<any>) => any,
|
||||
month: (...args: Array<any>) => any,
|
||||
day: (...args: Array<any>) => any,
|
||||
dayPeriod: (...args: Array<any>) => any
|
||||
},
|
||||
formatLong: Object,
|
||||
date: (...args: Array<any>) => any,
|
||||
time: (...args: Array<any>) => any,
|
||||
dateTime: (...args: Array<any>) => any,
|
||||
match: {
|
||||
ordinalNumber: (...args: Array<any>) => any,
|
||||
era: (...args: Array<any>) => any,
|
||||
quarter: (...args: Array<any>) => any,
|
||||
month: (...args: Array<any>) => any,
|
||||
day: (...args: Array<any>) => any,
|
||||
dayPeriod: (...args: Array<any>) => any
|
||||
},
|
||||
options?: {
|
||||
weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
|
||||
firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
|
||||
}
|
||||
}
|
||||
|
||||
declare module.exports: (
|
||||
date: Date | number,
|
||||
options?: {
|
||||
locale?: Locale,
|
||||
weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
|
||||
}
|
||||
) => boolean
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"sideEffects": false,
|
||||
"typings": "../../typings.d.ts"
|
||||
}
|
||||
Reference in New Issue
Block a user