@koalarx/utils
Version:
Biblioteca com validadores, conversores e abstrações de algumas problemáticas
47 lines (46 loc) • 2.08 kB
TypeScript
export declare class KlNumber extends Number {
/**
* Gera um número aleatório entre os valores mínimo e máximo especificados.
* @param min Valor mínimo do intervalo.
* @param max Valor máximo do intervalo.
* @returns Uma nova instância de `KlNumber` com o número aleatório gerado.
* @throws Erro se o valor mínimo for maior que o valor máximo.
*/
random(min: number, max: number): KlNumber;
/**
* Formata o número como uma moeda, utilizando prefixo, separadores de milhar e decimal.
* @param prefix Prefixo da moeda (ex.: 'R$').
* @param thousands Separador de milhar (ex.: '.').
* @param decimal Separador decimal (ex.: ',').
* @param decimalCount Número de casas decimais (padrão: 2).
* @returns Uma string representando o número formatado como moeda.
*/
maskCoin(prefix?: string, thousands?: string, decimal?: string, decimalCount?: number): string;
/**
* Converte a instância de `KlNumber` para um número primitivo.
* @returns O valor numérico da instância.
*/
toNumber(): number;
/**
* Formata um número com separadores de milhar e casas decimais.
* @param amount Valor numérico a ser formatado.
* @param decimalCount Número de casas decimais (padrão: 2).
* @param decimal Separador decimal (ex.: '.').
* @param thousands Separador de milhar (ex.: ',').
* @returns Uma string representando o número formatado.
*/
private formatMoney;
}
/**
* Função utilitária para formatar um número como moeda.
* @param value Valor numérico a ser formatado.
* @returns Uma string representando o número formatado como moeda.
*/
export declare function maskCoin(value: number): string;
/**
* Função utilitária para gerar um número aleatório.
* @param min Valor mínimo do intervalo (padrão: 0).
* @param max Valor máximo do intervalo (padrão: 99999999999).
* @returns Um número aleatório dentro do intervalo especificado.
*/
export declare function randomNumber(min?: number, max?: number): number;