Function clearParts

clearParts<const SpecificTimezone extends string>(
    inputFullDate: Readonly<FullDate<SpecificTimezone>>,
    parts: readonly (
        "year"
        | "month"
        | "day"
        | "hour"
        | "minute"
        | "second"
        | "millisecond"
    )[],
): {
    day: DayOfMonth;
    hour: Hour;
    millisecond: number;
    minute: Minute;
    month: MonthNumber;
    second: Minute;
    timezone: SpecificTimezone;
    year: number;
}
Clear all the selected parts of FullDate by setting them each to their lowest, valid value. See zeroDate for the lowest valid values for each property.
Type Parameters
- const SpecificTimezone extends string
Parameters
- inputFullDate: Readonly<FullDate<SpecificTimezone>>
- parts: readonly (
      "year"
      | "month"
      | "day"
      | "hour"
      | "minute"
      | "second"
      | "millisecond"
  )[]
Returns {
    day: DayOfMonth;
    hour: Hour;
    millisecond: number;
    minute: Minute;
    month: MonthNumber;
    second: Minute;
    timezone: SpecificTimezone;
    year: number;
}
- day: DayOfMonth
  A day of the month: 1-31 depending on the month
- hour: Hour
  Hour of the day in 24 time: 0-23
- millisecond: number
  Millisecond of the second: 0-999
- minute: Minute
  Minute of the hour: 0-59
- month: MonthNumber
  A month of the year: 1-12
- second: Minute
- timezone: SpecificTimezone
- year: number
  The full, four digit year.
  Example
  2023;
Example
```
import {clearTime, type FullDate} from 'date-vir';

const exampleDate: Readonly<FullDate> = {
    year: 2024,
    month: 1,
    day: 5,
    hour: 1,
    minute: 1,
    second: 1,
    millisecond: 1,
    timezone: 'UTC',
};

clearParts(exampleDate, [
    'year',
    'day',
]);
// `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: 'UTC'}`
```
- Defined in date-vir/src/extra-utils/zero.ts:95

Function clearParts

Type Parameters

Parameters

Returns { day: DayOfMonth; hour: Hour; millisecond: number; minute: Minute; month: MonthNumber; second: Minute; timezone: SpecificTimezone; year: number;}

day: DayOfMonth

hour: Hour

millisecond: number

minute: Minute

month: MonthNumber

second: Minute

timezone: SpecificTimezone

year: number

Example

Example

Settings

Returns {
day: DayOfMonth;
hour: Hour;
millisecond: number;
minute: Minute;
month: MonthNumber;
second: Minute;
timezone: SpecificTimezone;
year: number;
}