date

Creates a date schema.

// Date schema with an optional pipe
const Schema = date(pipe);

// Date schema with an optional message and pipe
const Schema = date(message, pipe);

Parameters

• message ErrorMessage | undefined
• pipe Pipe<Date> | undefined

Explanation

With date you can validate the data type of the input and with pipe you can transform and validate the further details of the date. If the input is not a date, you can use message to customize the error message.

Returns

• Schema DateSchema

Examples

The following examples show how date can be used.

Force minimum

Schema that forces a minimum date of today.

const MinDateSchema = date([toMinValue(new Date())]);

Validate range

Schema that validates a date in a range.

const DateRangeSchema = date([
  minValue(new Date(2019, 0, 1)),
  maxValue(new Date(2020, 0, 1)),
]);

Related

The following APIs can be combined with date.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom,
• toMaxValue,
• toMinValue

Validations

• custom,
• maxValue,
• minValue,
• notValue,
• value