@sankhyalabs/core 2.3.6 → 2.4.0

package/src/utils/ReadyUtil.ts

@@ -1,22 +1,38 @@
+/**
+ * `ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
+ */
 export default class ReadyUtil{
     private resolve:any;
     private promise:any;
     
+    /**
+     * Limpa o estado da instancia ao finalizar a execução do processo registrado.
+     */
     private clean() {
         this.resolve = undefined;
         this.promise = undefined;
     }
 
+    /**
+     * Inicializa o estado da instancia ao registrar processo.
+     */
     private start() {
         if(!this.promise) this.promise = new Promise((accept) => { 
             this.resolve = () => accept(true); 
         })
     }
 
+    /**
+     * Executa processo atribuído.
+     */
     end(){
         this.resolve && this.resolve();
     }
 
+    /**
+     *  Atribui processo que será executado por operações que o invocarem no método 'end'.
+     * @returns Promise que deve conter o código do processo.
+     */
     whenReady(){
         this.start();
         return new Promise((accept) => {

package/src/utils/StringUtils.ts

@@ -1,13 +1,15 @@
 /**
- * Classe com utiliários comuns para Strings.
+ * `StringUtils`: Utilizado para manipulação de Strings.
  */
 export class StringUtils {
 
     /**
-     * Verifica se a string está vazia.
+     * Retorna se a string está vazia.
      * Valores null e undefined são considerados como vazio.
      * 
-     * @param value  String para ser validada.
+     * @param value - String para ser validada.
+     * @returns - Verdadeiro caso a string não contenha informação.
+     * 
     */
     static isEmpty(value: any): Boolean {
 
@@ -48,7 +50,7 @@ export class StringUtils {
      * @param text  String para ser transformada.
      * @example entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
     */
-    static decodeHtmlEntities(text: string): string {
+       static decodeHtmlEntities(text: string): string {
         const entities = [
             ['amp', '&'],
             ['apos', '\''],
@@ -108,7 +110,8 @@ export class StringUtils {
 
     /**
     * Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta mantendo espaços e símbolos.
-    * @param text String para ser transformada.
+    * @param text - Texto para ser transformado.
+    * @returns - Texto sem acentuação e caixa alta, mantendo espaços e símbolos.
     */
     static replaceAccentuatedCharsKeepSymbols(text: string): string {
         return text.normalize("NFD").replace(/[\u0300-\u036f]/g, "").toUpperCase();
@@ -117,6 +120,9 @@ export class StringUtils {
     /**
      * Calcula um código hash para uma string.
      * @param value String que será gerado o hash code.
+     * @returns - Um hash calculado com base no valor informado.
+     * @example
+     * Informado: '123456' | Retorna: 1450575459
     */
     static hashCode(value: string): string {
         let hash = 0, i, chr;
@@ -130,9 +136,14 @@ export class StringUtils {
     }
 
     /** 
-     * Converte um valor em string para booleano
-     * @param value Valor a ser convertido
-     * @param defaultValue Será retornado esse caso seja passado valores diferentes do esperado(true, false, "true", "false", "S", "N") 
+     * Converte um texto do tipo string para um booleano.
+     * 
+     * @param value Valor a ser convertido.
+     * @param defaultValue Valor padrão.
+     * @returns - Texto convertido.
+     * @example
+     * Informado: 'true'  | Retorna: true
+     * Informado: 'false' | Retorna: false
     */
     static getBooleanValue(value:string, defaultValue:boolean = false): boolean {
         if([true, "true", "S"].includes(value)) {
@@ -146,6 +157,23 @@ export class StringUtils {
         }
     }
 
+    /**
+     * 
+     * Adiciona caracteres à esquerda caso texto seja menor que o valor do parâmetro len passado.
+     * 
+     * @param str - Texto para ser ajustado.
+     * @param len - Tamanho desejado do texto.
+     * @param pad - Caractere a ser adicionado a esquerda caso o texto menor que o tamanho passado.
+     * @returns - Texto passado se este for maior que o len.
+     * Ou retorna o texto com os caracteres adicionados na esquerda.
+     * 
+     * @example
+     * padStart('SANKHYA', 8,'.') | Retorna: '...SANKHYA'
+     * @example
+     * padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
+     * 
+     * 
+    */
     static padStart(str: string, len: number, pad: string = " "): string {
         str = str != undefined ? str : "";
         while (str.length < len) {
@@ -154,6 +182,23 @@ export class StringUtils {
         return str;
     }
 
+    /**
+     * 
+     * Adiciona caracteres à direita caso texto seja menor que o valor do parâmetro len passado.
+     * 
+     * @param str - Texto para ser ajustado.
+     * @param len - Tamanho desejado do texto.
+     * @param pad - Caractere a ser adicionado a direita caso o texto menor que o tamanho passado.
+     * @returns - Texto passado se este for maior que o len.
+     * Ou retorna o texto com os caracteres adicionados na direita.
+     * 
+     * @example
+     * padStart('SANKHYA', 8,'.') | Retorna: 'SANKHYA...'
+     * @example
+     * padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
+     * 
+     * 
+    */
     static padEnd(str: string, len: number, pad: string = " "): string {
         str = str != undefined ? str : "";
         while (str.length < len) {
@@ -164,12 +209,11 @@ export class StringUtils {
 
 
     /**
-     * Utilitário para determinar a ordem de strings. Geralmente usado no método "sort" de um array.
-     * Retorna um número negativo se o primeiro argumento é menor que o segundo, zero se os dois são iguais
-     * e um número positivo quando o primeiro é maior que o segundo.if they're equal, and a positive value otherwise.
-     * @param a - Primeira string para comparação
-     * @param b - Segunda string para comparação
-     * @returns Um valor maior, menor ou igual a zero para determinar se a ordem precisa ser alterada.
+     * Determina a ordem de strings.
+     *
+     * @param a - Primeira string para comparação.
+     * @param b - Segunda string para comparação.
+     * @returns - Um numeral negativo se o primeiro argumento é menor que o segundo, zero se os dois são iguais e um numeral positivo quando o primeiro é maior que o segundo.
      */
     static compare(a: string, b: string): number{
         
@@ -189,10 +233,13 @@ export class StringUtils {
     }
   
     /**
-     * Utilitário para converter string em camelCase 
+     * Converte string em camelCase.
      * Combina palavras compostas ou frases, alterando a inicial de cada uma, a partir da primeira, para maiúscula e unidas sem espaços.
-     * @param value String a ser convertida
-     * @returns String convertida em camelCase 
+     * @param value String a ser convertida.
+     * @returns String convertida em camelCase. 
+     * 
+     * @example
+     * toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
      */
     static toCamelCase(value: string): string {
         if(!value) return "";
@@ -205,10 +252,9 @@ export class StringUtils {
     }
 
     /**
-     * Utilitário para converter string em PascalCase 
-     * Combina palavras colocando todas as palavras em minúsculas (mesmo a primeira palavra) removendo espaços
-     * @param value String a ser convertida
-     * @returns String convertida em PascalCase 
+     * Converte string para PascalCase.
+     * @param value String a ser convertida.
+     * @returns String convertida em PascalCase.
      */
     static toPascalCase(value: string): string{
         return value
@@ -218,10 +264,9 @@ export class StringUtils {
     }
 
     /**
-     * Utilitário para converter string em snake_case
-     * Combina palavras substituindo cada espaço por um unsderscore (_) convertendo todas as letras para minúsculas
-     * @param value String a ser convertida
-     * @returns String convertida em snake_case
+     * Utilitário para converter string em snake_case.
+     * @param value String a ser convertida.
+     * @returns String convertida em snake_case.
      */
     static toSnakeCase(value: string): string{
         return value
@@ -232,10 +277,9 @@ export class StringUtils {
     }
 
     /**
-     * Utilitário para converter string em kebab-case
-     * Combina palavras substituindo cada espaço por um traço (-) convertendo todas as letras para minúsculas
-     * @param value String a ser convertida
-     * @returns String convertida em KebabCase 
+     * Utilitário para converter string em kebab-case.
+     * @param value String a ser convertida.
+     * @returns String convertida em KebabCase.
      */
     static toKebabCase(value: string): string{
         return value.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/[\s_]+/g, '-').toLowerCase();

package/src/utils/TimeFormatter.ts

@@ -1,18 +1,18 @@
 import { MaskFormatter } from "./MaskFormatter.js";
 
 /**
- * `TimeFormatter` é um utilitário para formatação de strings desformatadas em strings válidas de horários
+ * `TimeFormatter`: Utilizado para formatar horas.
  */
 export class TimeFormatter {
 
     static _maskFormatter: MaskFormatter = new MaskFormatter("##:##");
 
     /**
-    * @prepareValue: converts an unformated time string into a formatted time.
+    * Converte um texto para o formato de hora.
     *
-    * @param value unformated time string to convert
-    * 
-    * @returns formatted time string
+    * @param value - Texto não formatado.
+    * @param showSeconds - Se será validado os segundos. 
+    * @returns - Texto em formato de hora.
     * 
     * @Exemples
     * @"1012"       |       "10:12"
@@ -50,11 +50,11 @@ export class TimeFormatter {
     }
 
     /**
-    * @validateTime: validates if an input string has the corect time format.
+    * Retorna se o texto está no formato de hora.
     *
-    * @param value input string to validate
-    * 
-    * @returns true or false
+    * @param value - Texto a ser validado.
+    * @param showSeconds - Se será validado os segundos.
+    * @returns - Verdadeiro para valores no formato de hora e False para formatos diferentes.
     * 
     * @Exemples
     * @"1012"       |       true
@@ -64,7 +64,7 @@ export class TimeFormatter {
     static validateTime(value: string, showSeconds: boolean) {
         let isValid: boolean = true;
         if (value) {
-            let validationValue = value.replace(/:/g, "");
+            const validationValue = value.replace(/:/g, "");
             if (showSeconds) {
                 if (!["1", "2", "0"].includes(validationValue[0])) {
                     isValid = false;

package/src/utils/UserAgentUtils/index.ts

@@ -1,12 +1,24 @@
 import AGENT_LIST from "./navigatorAgentList.js"
 import { NumberUtils } from "../NumberUtils.js";
 
+/**
+ * `UserAgentUtils`: Utilitario para tratativas relacionadas ao navegador.
+ */
 export class UserAgentUtils {
+    
+    /**
+     * Obtém se o navegador do usuário é o firefox.
+     * @returns Verdadeiro se o navegador do usuário for o firefox.
+     */
     public static isFirefox() {
         const browser = this.getBrowserInfo();
         return !!browser.firefox;
     }
 
+    /**
+     * Obtém nome e versão do navegador que está sendo utilizado.
+     * @returns Objeto com o nome e versão do navegador.
+     */
     public static getBrowserInfo(): any {
         const userAgent = window.navigator.userAgent;
         let browser = { name: '', version: '' } as any;