mirror of
https://github.com/idrainformatica/PecFlow.git
synced 2026-06-17 05:05:44 +02:00
fase 5
This commit is contained in:
+56
@@ -0,0 +1,56 @@
|
||||
import type {
|
||||
NearestHours,
|
||||
NearestToUnitOptions,
|
||||
RoundingOptions,
|
||||
} from "./types.js";
|
||||
/**
|
||||
* The {@link roundToNearestHours} function options.
|
||||
*/
|
||||
export interface RoundToNearestHoursOptions
|
||||
extends NearestToUnitOptions<NearestHours>,
|
||||
RoundingOptions {}
|
||||
/**
|
||||
* @name roundToNearestHours
|
||||
* @category Hour Helpers
|
||||
* @summary Rounds the given date to the nearest hour
|
||||
*
|
||||
* @description
|
||||
* Rounds the given date to the nearest hour (or number of hours).
|
||||
* Rounds up when the given date is exactly between the nearest round hours.
|
||||
*
|
||||
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||||
*
|
||||
* @param date - The date to round
|
||||
* @param options - An object with options.
|
||||
*
|
||||
* @returns The new date rounded to the closest hour
|
||||
*
|
||||
* @example
|
||||
* // Round 10 July 2014 12:34:56 to nearest hour:
|
||||
* const result = roundToNearestHours(new Date(2014, 6, 10, 12, 34, 56))
|
||||
* //=> Thu Jul 10 2014 13:00:00
|
||||
*
|
||||
* @example
|
||||
* // Round 10 July 2014 12:34:56 to nearest half hour:
|
||||
* const result = roundToNearestHours(new Date(2014, 6, 10, 12, 34, 56), { nearestTo: 6 })
|
||||
* //=> Thu Jul 10 2014 12:00:00
|
||||
|
||||
* @example
|
||||
* // Round 10 July 2014 12:34:56 to nearest half hour:
|
||||
* const result = roundToNearestHours(new Date(2014, 6, 10, 12, 34, 56), { nearestTo: 8 })
|
||||
* //=> Thu Jul 10 2014 16:00:00
|
||||
|
||||
* @example
|
||||
* // Floor (rounds down) 10 July 2014 12:34:56 to nearest hour:
|
||||
* const result = roundToNearestHours(new Date(2014, 6, 10, 1, 23, 45), { roundingMethod: 'ceil' })
|
||||
* //=> Thu Jul 10 2014 02:00:00
|
||||
*
|
||||
* @example
|
||||
* // Ceil (rounds up) 10 July 2014 12:34:56 to nearest quarter hour:
|
||||
* const result = roundToNearestHours(new Date(2014, 6, 10, 12, 34, 56), { roundingMethod: 'floor', nearestTo: 8 })
|
||||
* //=> Thu Jul 10 2014 08:00:00
|
||||
*/
|
||||
export declare function roundToNearestHours<DateType extends Date>(
|
||||
date: DateType | number | string,
|
||||
options?: RoundToNearestHoursOptions,
|
||||
): Date;
|
||||
Reference in New Issue
Block a user