@leancodepl/api-date-datefns
Version:
Date-fns integration for API date type conversion
20 lines (19 loc) • 725 B
TypeScript
import type { ApiDateOnly } from "@leancodepl/api-date";
/**
* Converts JavaScript Date to ApiDateOnly using date-fns.
*
* Formats JavaScript Date object to API date string format with support
* for optional parameters. Uses date-fns format function internally.
*
* @param date - The JavaScript Date to convert
* @returns ApiDateOnly string or undefined if date is undefined
* @example
* ```typescript
* import { toApiDate } from '@leancodepl/api-date-datefns';
*
* const apiDate = toApiDate(new Date('2023-12-25'));
* console.log(apiDate); // '2023-12-25'
* ```
*/
export declare function toApiDate(date: Date): ApiDateOnly;
export declare function toApiDate(date: Date | undefined): ApiDateOnly | undefined;