startsWith

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

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

Generics

• TInput extends string
• TRequirement extends string

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

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

Returns

• Validation StartsWithValidation<TInput, TRequirement>

Examples

The following examples show how startsWith can be used.

HTTPS URL schema

Schema to validate a HTTPS URL.

const HttpsUrlSchema = string([url(), startsWith('https://')]);

Related

The following APIs can be combined with startsWith.

Schemas

• any,
• special,
• string,
• unknown