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 { getWeek } from 'date-fns'
|
||||
export default getWeek
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
import startOfWeek from '../startOfWeek/index.js';
|
||||
import startOfWeekYear from '../startOfWeekYear/index.js';
|
||||
import toDate from '../toDate/index.js';
|
||||
var MILLISECONDS_IN_WEEK = 604800000;
|
||||
/**
|
||||
* @name getWeek
|
||||
* @category Week Helpers
|
||||
* @summary Get the local week index of the given date.
|
||||
*
|
||||
* @description
|
||||
* Get the local week index of the given date.
|
||||
* The exact calculation depends on the values of
|
||||
* `options.weekStartsOn` (which is the index of the first day of the week)
|
||||
* and `options.firstWeekContainsDate` (which is the day of January, which is always in
|
||||
* the first week of the week-numbering year)
|
||||
*
|
||||
* Week numbering: https://en.wikipedia.org/wiki/Week#Week_numbering
|
||||
*
|
||||
* ### 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 given date
|
||||
* @param {Object} [options] - an 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)
|
||||
* @param {1|2|3|4|5|6|7} [options.firstWeekContainsDate=1] - the day of January, which is always in the first week of the year
|
||||
* @returns {Number} the week
|
||||
* @throws {TypeError} 1 argument required
|
||||
* @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
|
||||
* @throws {RangeError} `options.firstWeekContainsDate` must be between 1 and 7
|
||||
*
|
||||
* @example
|
||||
* // Which week of the local week numbering year is 2 January 2005 with default options?
|
||||
* var result = getISOWeek(new Date(2005, 0, 2))
|
||||
* //=> 2
|
||||
*
|
||||
* // Which week of the local week numbering year is 2 January 2005,
|
||||
* // if Monday is the first day of the week,
|
||||
* // and the first week of the year always contains 4 January?
|
||||
* var result = getISOWeek(new Date(2005, 0, 2), {
|
||||
* weekStartsOn: 1,
|
||||
* firstWeekContainsDate: 4
|
||||
* })
|
||||
* //=> 53
|
||||
*/
|
||||
|
||||
export default function getWeek(dirtyDate, options) {
|
||||
if (arguments.length < 1) {
|
||||
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||||
}
|
||||
|
||||
var date = toDate(dirtyDate);
|
||||
var diff = startOfWeek(date, options).getTime() - startOfWeekYear(date, options).getTime(); // Round the number of days to the nearest integer
|
||||
// because the number of milliseconds in a week is not constant
|
||||
// (e.g. it's different in the week of the daylight saving time clock shift)
|
||||
|
||||
return Math.round(diff / MILLISECONDS_IN_WEEK) + 1;
|
||||
}
|
||||
+45
@@ -0,0 +1,45 @@
|
||||
// @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,
|
||||
firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
|
||||
}
|
||||
) => number
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"sideEffects": false,
|
||||
"typings": "../../typings.d.ts"
|
||||
}
|
||||
Reference in New Issue
Block a user