hexColor

Creates a pipeline validation action that validates a hex color.

const Validation = hexColor<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With hexColor you can validate the formatting of a string. If the input is not a hex color, you can use message to customize the error message.

Returns

• Validation HexColorValidation<TInput>

Examples

The following examples show how hexColor can be used.

Hex color schema

Schema to validate a hex color.

const HexColorSchema = string([hexColor('The hex color is badly formatted.')]);

Related

The following APIs can be combined with hexColor.

Schemas

• any,
• special,
• string,
• unknown