types.pattern.md

Home > @skunkteam/types > pattern

pattern() function

Signature:

declare function pattern<const BrandName extends string>(
    name: BrandName,
    regExp: RegExp,
    customMessage?: StringTypeConfig['customMessage'],
): Type<Branded<string, BrandName>, StringTypeConfig>;

Parameters

Parameter	Type	Description
name	BrandName
regExp	RegExp
customMessage	StringTypeConfig['customMessage']	(Optional)

Returns:

Type<Branded<string, BrandName>, StringTypeConfig>