1.0.0 • Published 2 years ago
jabg-util-functions v1.0.0
Util Functions
Projeto com diversas fun;óes genéricas de uso geral
Esse pacote contém recursos que podem ser bastante úteis pois são funcionalidades que são quase sempre utilizadas durante o desenvolvimento de algum projeto. A ideia é a padronização e evitar a repetição de código pelos projetos desenvolvidos.
Tecnologia: TypeScript
Funcionalidades
1. Funções
| Função | Parâmetros | Retorno | ||
|---|---|---|---|---|
| isJsonString | str: string | boolean: Verifica se a string está formatada em JSON | ||
| handleResponse | data: T | T: varre os atributos da entrada e, caso seja uma string JSON, converte para JSON e retorna o objeto | ||
| getNumbersFromString | str: string | string: retorna somente os dígitos presentes na string fornecida | ||
| encrypt | password: string | Promise: criptografa o dado usando bcrypt | ||
| passwordMatch | hash: string, password: string | Promise: vefirica se a senha e o hash casam | ||
| stringJson | data: any | string: returna o objeto convertido em string JSON | ||
| objectJson | data: any | any: retorna o objeto convertido em JSON | ||
| cleanObject | obj: unknown | any: remove todos os atributos null ou undefined de um objeto e o retorna | ||
| getDateFromStringISO | date: string | Date: Converte para tipo Date uma string em formato ISO | ||
| formattedObject | object: unknown | unknown: Realiza um stringfy e em seguida um JSON parse sobre o objeto | ||
| getStringDateYYYYMMDD | date: Date | string: Recebe uma data e retorna uma string no formato YYYY-MM-DD | ||
| getDateNow | - | Date: Retorna a data de agora | ||
| formatDocument | document: string | string: retorna o CPF ou CNPJ mascarado, de acordo com o tamanho da entrada. | ||
| encodeBase64 | data: string | string: retorna o dado em base 64 | ||
| maskDocument | document: string | string: mascara o CPF ou CNPJ de acordo com o tamanho da entrada | ||
| expiredLogin | date: Date, expiresIn: number | boolean: retorna se a data informada já está expirada em relação à quantidade de segundos no expiresIn | ||
| getFormattedObject | object: any, objectFormatter: any | any: retorna um objeto com os dados do object, cujos atributos estão presentes no objectFormatter e não seja um dado null | ||
| formatParametersString | object: unknown | string: retorna uma string formatada como URL query de acordo com os atributos e valores do objeto de entrada | ||
| isFormattedError | object: any | boolean: verifica se o objeto contém algum atributo de exceção (response.error.exception) | ||
| thowApiError | error: Error, error2: Error | -: gera uma exceção caso o error seja um objeto com erro, caso não seja, lança uma exceção com o error2 | ||
| formatFieldString | field: string | string: aplica trim e retorna a string em caixa alta | ||
| formatEmail | email: string | string: aplica trim e retorna a string em caixa baixa | ||
| removeDashesFromUUID | uuid: string | string: remove os - de uma string UUID | ||
| formatUUID | uuid: string | string: adiciona os - de uma string UUID | ||
| formatDocumentFromNumberToString | document: number, personType: number | string: recebe o CPF ou CNPJ como dado numérico e realiza a formatação do mesmo, personType 0 - PF ou 1 - PJ | ||
| generatePassword | - | string: gera uma senha numérica aleatória com 8 dígitos | ||
| castToNumber | value: string, decimals: number = 2 | number: retorna a conversão da string em número, respeitando o número de casas decimais | ||
| generateFilterArray | length: number, params: any[] | number: retorna uma string como um array de parâmetros para ser usado no Postgres, a partir de um parâmetro (length) inicial, exemplo: '$1, $2, $3' | ||
| formatDate | value: Date, format: string = 'DD/MM/YYYY HH:mm' | string: retorna a data em string no formato especificado | ||
| dateStringDDMMYYYYToDate | dateString: string | Data: converte em data uma string no formato DD/MM/YYYY | ||
| maskContent | data: T[] | T, user: any | T[] | T: retorna o objeto mascarando dados sensíveis de acordo com as permissões do usuário |
| base64ToString | baseUrl: string | string: converte o dado de base64 para string | ||
| generateUuid | - | string: Gera um UUID v4 | ||
| formatCsvObject | obj: any | any: retorna o objeto deletando todos os atributos com valor vazio '' | ||
| removeDiacritics | str: string | string: remove todos os caracteres acentuados de uma string, substituindo por sua variante sem acentuação. Ex: José => Jose |
2. Paginação
| Recurso | Função |
|---|---|
| Page | classe que padroniza o retorno de dados vindos de um endpoint com paginação |
| Pagination | classe abstrata que adiciona os parâmetros page e size a qualquer classe, já devidamente tratados |
1.0.0
2 years ago