uuid

Creates a pipeline validation action that validates a UUID.

const Validation = uuid<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

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

Returns

• Validation UuidValidation<TInput>

Examples

The following examples show how uuid can be used.

UUID schema

Schema to validate an UUID.

const UuidSchema = string([uuid('The UUID is badly formatted.')]);

Related

The following APIs can be combined with uuid.

Schemas

• any,
• special,
• string,
• unknown