@koalarx/utils/KlString.d.ts

Biblioteca com validadores, conversores e abstrações de algumas problemáticas

import { KlNumber } from './KlNumber';
interface KlStringRandomOptions {
    numbers?: boolean;
    uppercase?: boolean;
    lowercase?: boolean;
    specialCharacters?: boolean;
}
export declare class KlString extends String {
    /**
     * Normaliza a string atual e remove caracteres especiais, como acentos.
     * @returns Uma nova instância de `KlString` contendo a string normalizada e sem caracteres especiais.
     */
    normalizeAndRemoveSpecialChars(): KlString;
    /**
     * Remove espaços da string atual, substituindo-os por um delimitador.
     * @param delimiter O delimitador que substituirá os espaços (padrão: '').
     * @returns Uma nova instância de `KlString` sem espaços.
     */
    removeSpaces(delimiter?: string): string;
    /**
     * Remove espaços e caracteres especiais de uma string.
     * @param delimiter O delimitador que substituirá os espaços e caracteres especiais (padrão: ' ').
     * @returns Uma nova instância de `KlString` contendo a string limpa.
     */
    clear(delimiter?: string): KlString;
    /**
     * Converte a string atual para o formato camelCase.
     * @returns Uma nova instância de `KlString` no formato camelCase.
     */
    toCamelCase(): KlString;
    /**
     * Remove a máscara de moeda da string atual e converte para um número.
     * @param decimalCount Número de casas decimais (padrão: 2).
     * @returns Uma instância de `KlNumber` contendo o valor numérico sem a máscara.
     */
    unmaskCoin(decimalCount?: number): KlNumber;
    /**
     * Concatena a string atual com outras strings fornecidas.
     * @param stringValue As strings a serem concatenadas.
     * @returns Uma nova instância de `KlString` com as strings concatenadas.
     */
    contatenate(...stringValue: string[]): KlString;
    /**
     * Concatena a string atual com outra string no início.
     * @param value A string a ser adicionada no início.
     * @returns Uma nova instância de `KlString` com a string concatenada.
     */
    concatenateToStart(value: string): KlString;
    /**
     * Gera uma string aleatória com o comprimento e opções especificados.
     * @param length O comprimento da string gerada.
     * @param options Opções para incluir letras maiúsculas, minúsculas, números e caracteres especiais.
     * @returns Uma nova instância de `KlString` contendo a string aleatória gerada.
     */
    random(length: number, { lowercase, uppercase, numbers, specialCharacters }: KlStringRandomOptions): KlString;
    /**
     * Aplica a máscara de CPF à string atual.
     * @returns Uma nova instância de `KlString` formatada como CPF (ex.: '123.456.789-00').
     */
    maskCpf(): KlString;
    /**
     * Aplica a máscara de CNPJ à string atual.
     * @returns Uma nova instância de `KlString` formatada como CNPJ (ex.: '12.345.678/0001-00').
     */
    maskCnpj(): KlString;
    /**
     * Valida se a string atual é um CPF válido.
     * @returns `true` se o CPF for válido, caso contrário `false`.
     */
    validateCpf(): boolean;
    /**
     * Valida se a string atual é um CNPJ válido.
     * @returns `true` se o CNPJ for válido, caso contrário `false`.
     */
    validateCnpj(): boolean;
    /**
     * Remove todos os caracteres não numéricos da string.
     * @returns Uma nova instância de `KlString` contendo apenas os números.
     */
    onlyNumbers(): KlString;
    /**
     * Substitui quebras de linha (`\n`, `\r\n`, `\r`) por tags HTML `<br/>`.
     * @returns Uma nova instância de `KlString` com as quebras de linha substituídas.
     */
    nbl2br(): KlString;
    /**
     * Converte a string atual para Base64.
     * @returns Uma nova instância de `KlString` contendo a string codificada em Base64.
     */
    toBase64(): KlString;
    /**
     * Adiciona caracteres de preenchimento à esquerda de uma string até atingir o comprimento total especificado.
     * @param value A string que será preenchida.
     * @param totalWidth O comprimento total desejado.
     * @param paddingChar O caractere de preenchimento (padrão: '0').
     * @returns Uma string preenchida com o caractere especificado.
     */
    private leftPad;
}
/**
 * Aplica a máscara de CPF a uma string.
 * @param value A string contendo o CPF (apenas números ou com formatação).
 * @returns Uma string formatada como CPF (ex.: '123.456.789-00').
 */
export declare function maskCpf(value: string): string;
/**
 * Aplica a máscara de CNPJ a uma string.
 * @param value A string contendo o CNPJ (apenas números ou com formatação).
 * @returns Uma string formatada como CNPJ (ex.: '12.345.678/0001-00').
 */
export declare function maskCnpj(value: string): string;
/**
 * Gera uma string aleatória com o comprimento e opções especificados.
 * @param length O comprimento da string gerada.
 * @param options Opções para incluir letras maiúsculas, minúsculas, números e caracteres especiais.
 * @returns Uma string aleatória gerada com base nas opções fornecidas.
 */
export declare function randomString(length: number, options?: KlStringRandomOptions): string;
/**
 * Remove espaços e caracteres especiais de uma string.
 * @param value A string a ser limpa.
 * @param delimiter O delimitador que substituirá os espaços e caracteres especiais (padrão: '').
 * @returns Uma string limpa.
 */
export declare function clear(value: string, delimiter?: string): string;
/**
 * Remove a máscara de moeda de uma string e converte para número.
 * @param value A string contendo o valor monetário.
 * @param decimalCount Número de casas decimais (padrão: 2).
 * @returns O valor numérico sem a máscara.
 */
export declare function unmaskCoin(value: string, decimalCount?: number): number;
/**
 * Remove a máscara de CPF de uma string, retornando apenas os números.
 * @param value A string contendo o CPF.
 * @returns Uma string contendo apenas os números do CPF.
 */
export declare function unmaskCpf(value: string): KlString;
/**
 * Remove a máscara de CNPJ de uma string, retornando apenas os números.
 * @param value A string contendo o CNPJ.
 * @returns Uma string contendo apenas os números do CNPJ.
 */
export declare function unmaskCnpj(value: string): KlString;
/**
 * Converte uma string para o formato camelCase.
 * @param value A string a ser convertida.
 * @returns Uma string no formato camelCase.
 */
export declare function toCamelCase(value: string): string;
/**
 * Substitui quebras de linha (`\n`, `\r\n`, `\r`) por tags HTML `<br/>`.
 * @param value A string contendo quebras de linha.
 * @returns Uma string com as quebras de linha substituídas por `<br/>`.
 */
export declare function nbl2br(value: string): string;
/**
 * Valida se uma string é um CPF válido.
 * @param value A string contendo o CPF.
 * @returns `true` se o CPF for válido, caso contrário `false`.
 */
export declare function validateCpf(value: string): boolean;
/**
 * Valida se uma string é um CNPJ válido.
 * @param value A string contendo o CNPJ.
 * @returns `true` se o CNPJ for válido, caso contrário `false`.
 */
export declare function validateCnpj(value: string): boolean;
export {};