isoWeek

Creates a pipeline validation action that validates a week.

const Validation = isoWeek<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With isoWeek you can validate the formatting of a string. If the input is not an ISO week, you can use message to customize the error message.

Returns

• Validation IsoWeekValidation<TInput>

Examples

The following examples show how isoWeek can be used.

ISO week schema

Schema to validate an ISO week.

const IsoWeekSchema = string([isoWeek('The week is badly formatted.')]);

Related

The following APIs can be combined with isoWeek.

Schemas

• any,
• special,
• string,
• unknown