endsWith

Creates a pipeline validation action that validates the end of a string.

const Validation = endsWith<TInput, TRequirement>(requirement, message);

Generics

• TInput extends string
• TRequirement extends string

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With endsWith you can validate the end of a string. If the end does not match the requirement, you can use message to customize the error message.

Returns

• Validation EndsWithValidation<TInput, TRequirement>

Examples

The following examples show how endsWith can be used.

Email schema

Schema to validate an email with a specific domain.

const EmailSchema = string([email(), endsWith('@example.com')]);

Related

The following APIs can be combined with endsWith.

Schemas

• any,
• special,
• string,
• unknown