creditCard

Creates a pipeline validation action that validates a credit card.

const Validation = creditCard<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With creditCard you can validate the formatting of a string. If the input is not a credit card, you can use message to customize the error message.

The following credit card providers are currently supported: American Express, Diners Card, Discover, JCB, Union Pay, Master Card, and Visa.

Returns

• Validation CreditCardValidation<TInput>

Examples

The following examples show how creditCard can be used.

Credit Card schema

Schema to validate a credit card.

const CreditCardSchema = string([
  creditCard('The credit card is badly formatted.'),
]);

Related

The following APIs can be combined with creditCard.

Schemas

• any,
• special,
• string,
• unknown