-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.d.ts
45 lines (38 loc) 路 1.05 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/**
Get the [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date) week number of a date
@param date - The date to get week number for.
@returns Week number of given date.
@example
```
import weekNumber from '@knutkirkhorn/week-number';
console.log(weekNumber());
// => 36
console.log(weekNumber(new Date()));
// => 36
console.log(weekNumber('September 3, 2019 13:33:37'));
// => 36
```
*/
export default function weekNumber(date: Date | string | void): Number;
/**
Get the [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date) week number of yesterday
@returns Week number of yesterday.
@example
```
import {yesterdayWeekNumber} from '@knutkirkhorn/week-number';
console.log(yesterdayWeekNumber());
// => 36
```
*/
export function yesterdayWeekNumber(): Number;
/**
Get the [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date) week number of tomorrow
@returns Week number of tomorrow.
@example
```
import {tomorrowWeekNumber} from '@knutkirkhorn/week-number';
console.log(tomorrowWeekNumber());
// => 36
```
*/
export function tomorrowWeekNumber(): Number;