UNPKG

date-vir

Version:

Easy and explicit dates and times.

github.com/electrovir/date-vir

electrovir/date-vir

36 lines (35 loc) • 1.64 kB
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
import { type PartialWithUndefined, type SetRequiredAndNotNull } from '@augment-vir/common'; import { type FullDate } from '../full-date/full-date-shape.js'; import { type Timezone } from '../timezone/timezones.js'; /** * Checks that the input has all the requested {@link FullDate} keys. * * @category Util * @example * * ```ts * import {hasFullDateKeys} from 'date-vir'; * * hasFullDateKeys({year: 2024}, ['year']); // `true` * hasFullDateKeys({year: 2024}, ['day']); // `false` * ``` */ export declare function hasFullDateKeys<SpecificTimezone extends Timezone, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, /** A union of strings. */ RequiredKeys extends keyof FullDate<SpecificTimezone>>(partialFullDate: PartialWithUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeys>): partialFullDate is SetRequiredAndNotNull<PartialFullDate, RequiredKeys>; /** * Asserts that the input has all the requested {@link FullDate} keys. * * @category Util * @example * * ```ts * import {assertHasFullDateKeys} from 'date-vir'; * * assertHasFullDateKeys({year: 2024}, ['year']); // passes * assertHasFullDateKeys({year: 2024}, ['day']); // fails * ``` */ export declare function assertHasFullDateKeys<SpecificTimezone extends Timezone, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, /** A union of strings. */ RequiredKeys extends keyof FullDate<SpecificTimezone>>(partialFullDate: PartialWithUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeys>): asserts partialFullDate is SetRequiredAndNotNull<PartialFullDate, RequiredKeys>;