zellige.js
Version:
A Moroccan utility library for working with CIN, phone numbers, currency, addresses, dates, and more.
79 lines (78 loc) • 2.84 kB
TypeScript
/**
* Validator module for various data validation operations
* @module validators
*/
/**
* Import CIN validation utilities
*/
import { validateCIN, generateTestCIN, getCINRegion, sanitizeCIN, isValidCIN } from './cin';
/**
* Import passport validation utilities
*/
import { validatePassport, isValidPassport, normalizePassport, formatPassport, generateRandomPassport, extractPassportComponents, arePassportsEquivalent } from './passport';
/**
* Import bank validation utilities
*/
import { isValidIBAN, isValidRIB, getBankDetails, getSwiftCode, madToWords } from './bank';
/**
* Import phone number validation utilities
*/
import { validatePhone, formatPhone, getPhoneDetails, extractPhoneNumbers, maskPhone, arePhoneNumbersEqual, sanitizePhone } from './phone-number';
/**
* Collection of all validator namespaces
*/
export declare const validators: {
cin: {
validate: typeof validateCIN;
generateTest: typeof generateTestCIN;
getRegion: typeof getCINRegion;
sanitize: typeof sanitizeCIN;
isValid: typeof isValidCIN;
};
passport: {
validate: typeof validatePassport;
isValid: typeof isValidPassport;
normalize: typeof normalizePassport;
format: typeof formatPassport;
generateRandom: typeof generateRandomPassport;
extractComponents: typeof extractPassportComponents;
areEquivalent: typeof arePassportsEquivalent;
};
bank: {
isValidIBAN: typeof isValidIBAN;
isValidRIB: typeof isValidRIB;
getDetails: typeof getBankDetails;
getSwiftCode: typeof getSwiftCode;
madToWords: typeof madToWords;
};
phone: {
validate: typeof validatePhone;
format: typeof formatPhone;
getDetails: typeof getPhoneDetails;
extract: typeof extractPhoneNumbers;
mask: typeof maskPhone;
areEqual: typeof arePhoneNumbersEqual;
sanitize: typeof sanitizePhone;
};
};
/**
* Default export providing access to all validator functions
* @default
*/
export default validators;
/**
* Direct exports of CIN validation functions for granular imports
*/
export { validateCIN, generateTestCIN, getCINRegion, sanitizeCIN, isValidCIN };
/**
* Direct exports of passport validation functions for granular imports
*/
export { validatePassport, isValidPassport, normalizePassport, formatPassport, generateRandomPassport, extractPassportComponents, arePassportsEquivalent, };
/**
* Direct exports of bank validation functions for granular imports
*/
export { isValidIBAN, isValidRIB, getBankDetails, getSwiftCode, madToWords };
/**
* Direct exports of phone number validation functions for granular imports
*/
export { validatePhone, formatPhone, getPhoneDetails, extractPhoneNumbers, maskPhone, arePhoneNumbersEqual, sanitizePhone, };