UNPKG

@burglekitt/gmt

Version:

Temporal-based date and time utilities with timezone support and polyfill integration

github.com/burglekitt/gmt

burglekitt/gmt

22 lines (21 loc) • 926 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import type { DateCycleField } from "../../types/index.js"; /** * Return true when `field` is a valid DateCycleField. * * - Valid fields are: "year", "month", "day". * - Accepts any input type and returns false for non-string values. * - Note "week" is a valid DateUnit elsewhere in GMT but is NOT a valid cycle field — it isn't a * `.with()`-settable field, so it can't be cycled. * * @param field candidate value of any type * @returns boolean indicating validity * * @example isValidDateCycleField("year") // true * @example isValidDateCycleField("month") // true * @example isValidDateCycleField("day") // true * @example isValidDateCycleField("week") // false * @example isValidDateCycleField("invalid") // false * @example isValidDateCycleField(123) // false * @example isValidDateCycleField(null) // false */ export declare function isValidDateCycleField(field: unknown): field is DateCycleField;