startsWith

Creates a starts with validation action.

const Action = v.startsWith<TInput, TRequirement, TMessage>(
  requirement,
  message
);

Generics

Parameters

  • requirement TRequirement
  • message TMessage

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

Examples

The following examples show how startsWith can be used.

HTTPS URL schema

Schema to validate a HTTPS URL.

const HttpsUrlSchema = v.pipe(v.string(), v.url(), v.startsWith('https://'));

The following APIs can be combined with startsWith.

Schemas

Methods

Utils

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of andrew-d-jackson
  • GitHub profile picture of dslatkin