@brasil-interface/utils
Version:
127 lines • 4.12 kB
TypeScript
export declare class CPF {
private static readonly MOD_ALG;
private static readonly LENGTH;
private static readonly BASE_NUMERALS_LENGTH;
private static readonly VERIFIER_DIGITS_LENGTH;
private static readonly UF_DIGIT_POSITION;
private static readonly BASE_NUMERALS_START;
private static readonly BASE_NUMERALS_END;
private static readonly FIRST_VERIFIER_DIGIT_WEIGHTS;
private static readonly SECOND_VERIFIER_DIGIT_WEIGHTS;
private static readonly MASK_REGEX;
private static readonly MASK_PATTERN;
private static readonly MASK_SENSITIVE_PATTERN;
private static readonly BLACKLIST;
private static readonly UF_MAP;
private static readonly VALIDATION_RULES;
/**
* PT-BR: Verifica se um número de CPF é válido.
*
* EN: Checks if a CPF number is valid.
*
* @param cpf - PT-BR: O número de CPF. EN: The CPF number.
* @returns PT-BR: `true` se o número de CPF for válido. EN: `true` if the CPF number is valid.
*
* @example
* ```
* CPF.isValid("000.000.000-00"); // false
* CPF.isValid("00000000192"); // false
* CPF.isValid("209.936.850-30"); // true
* CPF.isValid("20993685030"); // true
* ```
*/
static isValid(cpf: string | number): boolean;
/**
* PT-BR: Aplica a máscara de CPF em um número de CPF.
*
* EN: Applies the CPF mask to a CPF number.
*
* @param cpf - PT-BR: O número de CPF. EN: The CPF number.
* @returns PT-BR: O número de CPF com a máscara aplicada. EN: The CPF number with the mask applied.
*
* @example
* ```
* CPF.mask("20993685030"); // "209.936.850-30"
* ```
*/
static mask(cpf: string | number): string;
/**
* PT-BR: Máscara um número de CPF,
* Útil para exibir dados sensíveis.
*
* EN: Masks a CPF number,
* Useful for displaying sensitive data.
*
* @param cpf - PT-BR: O número de CPF. EN: The CPF number.
* @returns PT-BR: O número de CPF mascarado. EN: The masked CPF number.
*
* @example
* ```
* CPF.maskSensitive("20993685030"); // "209.936.***-**"
* ```
*/
static maskSensitive(cpf: string | number): string;
/**
* PT-BR: Remove a máscara de CPF de um número de CPF.
*
* EN: Removes the CPF mask from a CPF number.
*
* @param cpf - PT-BR: O número de CPF. EN: The CPF number.
* @returns PT-BR: O número de CPF sem a máscara. EN: The CPF number without the mask.
*
* @example
* ```
* CPF.unmask("209.936.850-30"); // "20993685030"
* ```
*/
static unmask(cpf: string | number): string;
/**
* PT-BR: Gera um número de CPF aleatório.
*
* EN: Generates a random CPF number.
*
* @returns PT-BR: O número de CPF gerado. EN: The generated CPF number.
*
* @example
* ```
* CPF.generate(); // "20993685030"
* ```
*/
static generate(): string;
/**
* PT-BR: Gera um número de CPF aleatório.
*
* EN: Generates a random CPF number.
*
* @returns PT-BR: O número de CPF gerado. EN: The generated CPF number.
*
* @example
* ```
* CPF.generate(); // "209.936.850-30"
* ```
*/
static generateMasked(): string;
/**
* PT-BR: Obtém a UF de um número de CPF.
*
* EN: Gets the UF of a CPF number.
*
* @param cpf - PT-BR: O número de CPF. EN: The CPF number.
* @returns PT-BR: A UF do número de CPF. EN: The UF of the CPF number.
*
* @example
* ```
* CPF.getUf("20993685030"); // "RS"
* ```
*/
static getEstado(cpf: string | number): (typeof this.UF_MAP)[keyof typeof this.UF_MAP] | null;
private static isUfKey;
private static clear;
private static getUfCode;
private static shouldHaveValidVerifierDigits;
private static getBaseNumerals;
private static calculateVerifierDigits;
private static calculateFirstVerifierDigit;
private static calculateSecondVerifierDigit;
}
//# sourceMappingURL=CPF.d.ts.map