1234567891011121314151617181920212223242526272829 |
- import type { ContextOptions } from "./types.js";
- /**
- * The {@link startOfYesterday} function options.
- */
- export interface StartOfYesterdayOptions<DateType extends Date = Date>
- extends ContextOptions<DateType> {}
- /**
- * @name startOfYesterday
- * @category Day Helpers
- * @summary Return the start of yesterday.
- * @pure false
- *
- * @typeParam ContextDate - The `Date` type of the context function.
- *
- * @param options - An object with options
- *
- * @description
- * Return the start of yesterday.
- *
- * @returns The start of yesterday
- *
- * @example
- * // If today is 6 October 2014:
- * const result = startOfYesterday()
- * //=> Sun Oct 5 2014 00:00:00
- */
- export declare function startOfYesterday<ContextDate extends Date>(
- options?: StartOfYesterdayOptions<ContextDate> | undefined,
- ): ContextDate;
|