date-vir/dist/full-date/parsing.d.ts

Easy and explicit dates and times.

import { type Timezone } from '../timezone/timezones.js';
import { type FullDate } from './full-date-shape.js';
/**
 * Parses any date string into a {@link FullDate} using the specified pattern and timezone. Prefer
 * using {@link createFullDate} if possible.
 *
 * Since this supports any arbitrary date string pattern, it is more flexible than
 * {@link createFullDate} but you must know the date pattern ahead of time.
 *
 * The `formatString` input is passed to Luxon. All format pattern options are listed here:
 * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
 *
 * @category FullDate
 */
export declare function parseDateStringWithPattern<const SpecificTimezone extends Timezone>({ dateString, formatString, timezone, }: {
    /** The date string to be parsed. */
    dateString: string;
    /**
     * The format string that should match Luxon's expectations here:
     * https://moment.github.io/luxon/#/parsing?id=table-of-tokens
     */
    formatString: string;
    /** The timezone that this date/time is meant for / originated from. */
    timezone: SpecificTimezone;
}): FullDate<SpecificTimezone>;
/**
 * Read either an `HTMLInputElement`'s value directly, or the value string retrieved from an
 * `HTMLInputElement`. Handles both `type="date"` and `type="time"` <input> elements.
 *
 * @category FullDate
 * @category HTML
 */
export declare function parseInputElementValue<const SpecificTimezone extends Timezone>(elementOrValue: Readonly<Pick<HTMLInputElement, 'value'>> | string | null | undefined, timezone: SpecificTimezone): FullDate<SpecificTimezone> | undefined;