1234567891011121314151617181920212223242526272829303132333435 |
- import type { DateArg, ContextOptions } from "./types.js";
- /**
- * The {@link startOfSecond} function options.
- */
- export interface StartOfSecondOptions<DateType extends Date = Date>
- extends ContextOptions<DateType> {}
- /**
- * @name startOfSecond
- * @category Second Helpers
- * @summary Return the start of a second for the given date.
- *
- * @description
- * Return the start of a second for the given date.
- * The result will be in the local timezone.
- *
- * @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 original date
- * @param options - The options
- *
- * @returns The start of a second
- *
- * @example
- * // The start of a second for 1 December 2014 22:15:45.400:
- * const result = startOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
- * //=> Mon Dec 01 2014 22:15:45.000
- */
- export declare function startOfSecond<
- DateType extends Date,
- ResultDate extends Date = DateType,
- >(
- date: DateArg<DateType>,
- options?: StartOfSecondOptions<ResultDate> | undefined,
- ): ResultDate;
|