timepiece/node_modules/date-fns/isExists.d.ts

30 lines
643 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name isExists
* @category Common Helpers
* @summary Is the given date exists?
*
* @description
* Checks if the given arguments convert to an existing date.
*
* @param year - The year of the date to check
* @param month - The month of the date to check
* @param day - The day of the date to check
*
* @returns `true` if the date exists
*
* @example
* // For the valid date:
* const result = isExists(2018, 0, 31)
* //=> true
*
* @example
* // For the invalid date:
* const result = isExists(2018, 1, 31)
* //=> false
*/
export declare function isExists(
year: number,
month: number,
day: number,
): boolean;