react-creditcard-validator
Version:
A fully typed React custom hook for formatting and validating payment card input fields
33 lines (32 loc) • 2.05 kB
TypeScript
export declare const EMPTY_CARD_NUMBER = "Enter a card number";
export declare const EMPTY_EXPIRY_DATE = "Enter an expiry date";
export declare const EMPTY_CVC = "Enter a CVC";
export declare const INVALID_CARD_NUMBER = "Card number is invalid";
export declare const INVALID_EXPIRY_DATE = "Expiry date is invalid";
export declare const INVALID_CVC = "CVC is invalid";
export declare const MONTH_OUT_OF_RANGE = "Expiry month must be between 01 and 12";
export declare const YEAR_OUT_OF_RANGE = "Expiry year cannot be in the past";
export declare const DATE_OUT_OF_RANGE = "Expiry date cannot be in the past";
export declare const hasCardNumberReachedMaxLength: (currentValue: string) => boolean;
export declare const validateLuhn: (cardNumber: string) => boolean;
/**
* Validates card number inputs, checking against empty inputs, and validating with the `validateLuhn` method & custom validation through the `cardNumberValidator` function.
* @param cardNumber
* @param {Function} cardNumberValidator
* @returns string | undefined
*/
export declare const getCardNumberError: (cardNumber: string, cardNumberValidator?: ((cardNumber: string) => string | undefined) | undefined) => string | undefined;
/**
* Validates expiry date inputs, checking against empty inputs, invalid months / years, or past dates. Also provides custom validation through the `expiryDateValidator` function
* @param expiryDate
* @param {Function} expiryDateValidator
* @returns string | undefined
*/
export declare const getExpiryDateError: (expiryDate: string, expiryDateValidator?: ((month: string, year: string) => string | undefined) | undefined) => string | undefined;
/**
* Validates cvc input, checking for empty inputs & incomplete inputs. Also invokes user custom validation logic if its exists.
* @param {string} cvc
* @param {Function} [cvcValidator]
* @returns string | undefined
*/
export declare const getCVCError: (cvc: string, cvcValidator?: ((cvc: string) => string | undefined) | undefined) => string | undefined;