shelving/schema/DateTimeSchema.js

Toolkit for using data in JavaScript.

import { formatDateTime } from "../util/format.js";
import { DateSchema } from "./DateSchema.js";
import { NULLABLE } from "./NullableSchema.js";
/**
 * Define a valid UTC date in ISO 8601 format, e.g. `2005-09-12T18:15:00.000Z`
 * - The date includes the `Z` suffix to indicate UTC time, this ensures consistent transfer of the date between client and server.
 * - If you wish to define an _abstract_ date without a timezone, e.g. a birthday or anniversary, use `DateSchema` instead.
 * - If you wish to define an _abstract_ time without a timezone, e.g. a daily alarm, use `TimeSchema` instead.
 */
export class DateTimeSchema extends DateSchema {
    constructor({ one = "time", title = "Time", input = "datetime-local", ...options }) {
        super({ one, title, input, ...options });
    }
    format(value) {
        return formatDateTime(value);
    }
    stringify(value) {
        return value.toISOString();
    }
}
/** Valid datetime, e.g. `2005-09-12T08:00:00Z` (required because falsy values are invalid). */
export const DATETIME = new DateTimeSchema({});
/** Valid datetime, e.g. `2005-09-12T21:30:00Z`, or `null` */
export const NULLABLE_DATETIME = NULLABLE(DATETIME);