📝 Commit Details:
This commit is contained in:
58
backend/node_modules/date-fns/roundToNearestMinutes.d.ts
generated
vendored
Normal file
58
backend/node_modules/date-fns/roundToNearestMinutes.d.ts
generated
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
import type {
|
||||
ContextOptions,
|
||||
DateArg,
|
||||
NearestMinutes,
|
||||
NearestToUnitOptions,
|
||||
RoundingOptions,
|
||||
} from "./types.js";
|
||||
/**
|
||||
* The {@link roundToNearestMinutes} function options.
|
||||
*/
|
||||
export interface RoundToNearestMinutesOptions<DateType extends Date = Date>
|
||||
extends NearestToUnitOptions<NearestMinutes>,
|
||||
RoundingOptions,
|
||||
ContextOptions<DateType> {}
|
||||
/**
|
||||
* @name roundToNearestMinutes
|
||||
* @category Minute Helpers
|
||||
* @summary Rounds the given date to the nearest minute
|
||||
*
|
||||
* @description
|
||||
* Rounds the given date to the nearest minute (or number of minutes).
|
||||
* Rounds up when the given date is exactly between the nearest round minutes.
|
||||
*
|
||||
* @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).
|
||||
* @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
||||
*
|
||||
* @param date - The date to round
|
||||
* @param options - An object with options.
|
||||
*
|
||||
* @returns The new date rounded to the closest minute
|
||||
*
|
||||
* @example
|
||||
* // Round 10 July 2014 12:12:34 to nearest minute:
|
||||
* const result = roundToNearestMinutes(new Date(2014, 6, 10, 12, 12, 34))
|
||||
* //=> Thu Jul 10 2014 12:13:00
|
||||
*
|
||||
* @example
|
||||
* // Round 10 July 2014 12:12:34 to nearest quarter hour:
|
||||
* const result = roundToNearestMinutes(new Date(2014, 6, 10, 12, 12, 34), { nearestTo: 15 })
|
||||
* //=> Thu Jul 10 2014 12:15:00
|
||||
*
|
||||
* @example
|
||||
* // Floor (rounds down) 10 July 2014 12:12:34 to nearest minute:
|
||||
* const result = roundToNearestMinutes(new Date(2014, 6, 10, 12, 12, 34), { roundingMethod: 'floor' })
|
||||
* //=> Thu Jul 10 2014 12:12:00
|
||||
*
|
||||
* @example
|
||||
* // Ceil (rounds up) 10 July 2014 12:12:34 to nearest half hour:
|
||||
* const result = roundToNearestMinutes(new Date(2014, 6, 10, 12, 12, 34), { roundingMethod: 'ceil', nearestTo: 30 })
|
||||
* //=> Thu Jul 10 2014 12:30:00
|
||||
*/
|
||||
export declare function roundToNearestMinutes<
|
||||
DateType extends Date,
|
||||
ResultDate extends Date = DateType,
|
||||
>(
|
||||
date: DateArg<DateType>,
|
||||
options?: RoundToNearestMinutesOptions<ResultDate>,
|
||||
): ResultDate;
|
Reference in New Issue
Block a user