string

Creates a string schema.

// String schema with an optional pipe
const Schema = string(pipe);

// String schema with an optional message and pipe
const Schema = string(message, pipe);

Parameters

• message ErrorMessage | undefined
• pipe Pipe<string> | undefined

Explanation

With string you can validate the data type of the input and with pipe you can transform and validate the further details of the string. If the input is not a string, you can use message to customize the error message.

Returns

• Schema StringSchema

Examples

The following examples show how string can be used.

Email schema

Schema to validate an email.

const EmailSchema = string([
  minLength(1, 'Please enter your email.'),
  email('The email is badly formatted.'),
  maxLength(30, 'Your email is too long.'),
]);

Password schema

Schema to validate a password.

const PasswordSchema = string([
  minLength(8, 'Your password is too short.'),
  maxLength(30, 'Your password is too long.'),
  regex(/[a-z]/, 'Your password must contain a lowercase letter.'),
  regex(/[A-Z]/, 'Your password must contain a uppercase letter.'),
  regex(/[0-9]/, 'Your password must contain a number.'),
]);

URL schema

Schema to validate a URL.

const UrlSchema = string('A URL must be string.', [
  url('The URL is badly formatted.'),
]);

Related

The following APIs can be combined with string.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toTrimmed,
• toTrimmedEnd,
• toTrimmedStart,
• toUpperCase

Validations

• bic,
• bytes,
• creditCard,
• cuid2,
• custom,
• decimal,
• email,
• emoji,
• endsWith,
• excludes,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• mac,
• mac48,
• mac64,
• maxBytes,
• maxLength,
• maxValue,
• minBytes,
• minLength,
• minValue,
• notBytes,
• notLength,
• notValue,
• octal,
• regex,
• startsWith,
• ulid,
• url,
• uuid,
• value