21 lines
487 B
TypeScript
21 lines
487 B
TypeScript
|
import type { DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* @name isPast
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Is the given date in the past?
|
||
|
|
* @pure false
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date in the past?
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
*
|
||
|
|
* @returns The date is in the past
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If today is 6 October 2014, is 2 July 2014 in the past?
|
||
|
|
* const result = isPast(new Date(2014, 6, 2))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isPast(date: DateArg<Date> & {}): boolean;
|