includes

The string contains value.

Signature

function includes(value: string, msg?: Message): Action<string>

Parameters

Parameter	Type	Description
value	string	The substring
msg	Message	Custom error message

Error codes

Code	When	Default message
includes	The condition is not met	Must contain "{value}"

You can change the texts: see Messages & i18n.

Notes

Case-sensitive. To ignore case, add toLowerCase before the rule.

Example

pipe(string(), includes('@'))

See also

• pattern — complex conditions