UNPKG

@prismicio/helpers

Version:
16 lines (15 loc) 858 B
import type { DateField, TimestampField } from "@prismicio/types"; /** * The return type of `asDate()`. */ type AsDateReturnType<Field extends DateField | TimestampField | null | undefined> = Field extends DateField<"filled"> | TimestampField<"filled"> ? Date : null; /** * Transforms a date or timestamp field into a JavaScript Date object * * @param dateOrTimestampField - A date or timestamp field from Prismic * * @returns A Date object, null if provided date is falsy * @see Templating date field from Prismic {@link https://prismic.io/docs/technologies/templating-date-field-javascript} */ export declare const asDate: <Field extends `${number}-${number}-${number}` | `${number}-${number}-${number}T${number}:${number}:${number}+${number}` | null | undefined>(dateOrTimestampField: Field) => AsDateReturnType<Field>; export {};