@brasil-interface/utils
Version:
110 lines • 3.92 kB
TypeScript
export declare namespace RG {
class SP {
private static readonly MOD_ALG;
static CLEAR_REGEX: RegExp;
private static readonly LENGTH;
private static readonly BASE_NUMERALS_LENGTH;
private static readonly VERIFIER_DIGITS_LENGTH;
private static readonly BASE_NUMERALS_START;
private static readonly BASE_NUMERALS_END;
private static readonly WEIGHTS;
private static readonly MASK_REGEX;
private static readonly MASK_PATTERN;
private static readonly MASK_SENSITIVE_PATTERN;
private static readonly BLACKLIST;
private static readonly VALIDATION_RULES;
/**
* PT-BR: Verifica se um número de RG é válido.
*
* EN: Checks if an RG number is valid.
*
* @param rg - PT-BR: O número de RG. EN: The RG number.
* @returns PT-BR: `true` se o número de RG for válido. EN: `true` if the RG number is valid.
*
* @example
* ```
* RG.SP.isValid("00.000.000-0"); // false
* RG.SP.isValid("000000001"); // false
* RG.SP.isValid("20.336.104-0"); // true
* RG.SP.isValid("203361040"); // true
* ```
*/
static isValid(rg: string | number): boolean;
/**
* PT-BR: Aplica uma máscara a um número de RG.
*
* EN: Masks an RG number.
*
* @param rg - PT-BR: O número de RG. EN: The RG number.
* @returns PT-BR: O número de RG com máscara. EN: The masked RG number.
*
* @example
* ```
* RG.SP.mask("203361040"); // "20.336.104-0"
* RG.SP.mask("20.336.104-0"); // "20.336.104-0"
* ```
*/
static mask(rg: string | number): string;
/**
* PT-BR Aplica uma máscara a um número de RG, mas esconde os dígitos finais.
*
* EN: Masks an RG number, but hides the final digits.
*
* @param rg - PT-BR: O número de RG. EN: The RG number.
* @returns PT-BR: O número de RG com máscara. EN: The masked RG number.
*
* @example
* ```
* RG.SP.maskSensitive("203361040"); // "20.336.***-*"
* RG.SP.maskSensitive("20.336.104-0"); // "20.336.***-*"
* ```
*/
static maskSensitive(rg: string | number): string;
/**
* PT-BR: Remove a máscara de um número de RG.
*
* EN: Removes the mask from an RG number.
*
* @param rg - PT-BR: O número de RG. EN: The RG number.
* @returns PT-BR: O número de RG sem máscara. EN: The unmasked RG number.
*
* @example
* ```
* RG.SP.unmask("20.336.104-0"); // "203361040"
* RG.SP.unmask("203361040"); // "203361040"
* ```
*/
static unmask(rg: string | number): string;
/**
* PT-BR: Gera um número de RG aleatório.
*
* EN: Generates a random RG number.
*
* @returns PT-BR: O número de RG gerado. EN: The generated RG number.
*
* @example
* ```
* RG.SP.generate(); // "203361040"
* ```
*/
static generate(): string;
/**
* PT-BR: Gera um número de RG aleatório com máscara.
*
* EN: Generates a random RG number with mask.
*
* @returns PT-BR: O número de RG gerado com máscara. EN: The generated RG number with mask.
*
* @example
* ```
* RG.SP.generateMasked(); // "20.336.104-0"
* ```
*/
static generateMasked(): string;
private static clear;
private static shouldHaveValidVerifierDigits;
private static getBaseNumerals;
private static calculateVerifierDigit;
}
}
//# sourceMappingURL=RG.d.ts.map