12345678910111213141516171819202122232425262728293031323334 |
- import { addMilliseconds } from "./addMilliseconds.js";
- /**
- * The {@link addSeconds} function options.
- */
- /**
- * @name addSeconds
- * @category Second Helpers
- * @summary Add the specified number of seconds to the given date.
- *
- * @description
- * Add the specified number of seconds to the given date.
- *
- * @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 be changed
- * @param amount - The amount of seconds to be added.
- * @param options - An object with options
- *
- * @returns The new date with the seconds added
- *
- * @example
- * // Add 30 seconds to 10 July 2014 12:45:00:
- * const result = addSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
- * //=> Thu Jul 10 2014 12:45:30
- */
- export function addSeconds(date, amount, options) {
- return addMilliseconds(date, amount * 1000, options);
- }
- // Fallback for modularized imports:
- export default addSeconds;
|