@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/classes/StringUtils.md

@@ -0,0 +1,562 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / StringUtils
+
+# Class: StringUtils
+
+`StringUtils`: Utilizado para manipulação de Strings.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](StringUtils.md#constructor)
+
+### Methods
+
+- [compare](StringUtils.md#compare)
+- [decodeHtmlEntities](StringUtils.md#decodehtmlentities)
+- [formatBytes](StringUtils.md#formatbytes)
+- [generateUUID](StringUtils.md#generateuuid)
+- [getBooleanValue](StringUtils.md#getbooleanvalue)
+- [hashCode](StringUtils.md#hashcode)
+- [isEmpty](StringUtils.md#isempty)
+- [padEnd](StringUtils.md#padend)
+- [padStart](StringUtils.md#padstart)
+- [prettyPrecision](StringUtils.md#prettyprecision)
+- [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
+- [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
+- [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
+- [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
+- [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
+- [toCamelCase](StringUtils.md#tocamelcase)
+- [toKebabCase](StringUtils.md#tokebabcase)
+- [toPascalCase](StringUtils.md#topascalcase)
+- [toSnakeCase](StringUtils.md#tosnakecase)
+
+## Constructors
+
+### constructor
+
+• **new StringUtils**()
+
+## Methods
+
+### compare
+
+▸ `Static` **compare**(`a`, `b`): `number`
+
+Determina a ordem de strings.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `a` | `string` | Primeira string para comparação. |
+| `b` | `string` | Segunda string para comparação. |
+
+#### Returns
+
+`number`
+
+- 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.
+
+#### Defined in
+
+src/utils/StringUtils.ts:223
+
+___
+
+### decodeHtmlEntities
+
+▸ `Static` **decodeHtmlEntities**(`text`): `string`
+
+Converte todas as entidades HTML de um texto
+
+**`Example`**
+
+```ts
+entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | String para ser transformada. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:55
+
+___
+
+### formatBytes
+
+▸ `Static` **formatBytes**(`bytes`): `string`
+
+Utilitário para formatar bytes em string legível, convertendo para 
+múltiplos maiores caso necessário.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `bytes` | `number` |
+
+#### Returns
+
+`string`
+
+string formatada de acordo com a unidade.
+
+#### Defined in
+
+src/utils/StringUtils.ts:308
+
+___
+
+### generateUUID
+
+▸ `Static` **generateUUID**(): `string`
+
+Método utilizado para gerar IDs únicos.
+
+#### Returns
+
+`string`
+
+id único randômico.
+
+#### Defined in
+
+src/utils/StringUtils.ts:355
+
+___
+
+### getBooleanValue
+
+▸ `Static` **getBooleanValue**(`value`, `defaultValue?`): `boolean`
+
+Converte um texto do tipo string para um booleano.
+
+**`Example`**
+
+```ts
+Informado: 'true'  | Retorna: true
+Informado: 'false' | Retorna: false
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | Valor a ser convertido. |
+| `defaultValue` | `boolean` | `false` | Valor padrão. |
+
+#### Returns
+
+`boolean`
+
+- Texto convertido.
+
+#### Defined in
+
+src/utils/StringUtils.ts:153
+
+___
+
+### hashCode
+
+▸ `Static` **hashCode**(`value`): `string`
+
+Calcula um código hash para uma string.
+
+**`Example`**
+
+```ts
+Informado: '123456' | Retorna: 1450575459
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String que será gerado o hash code. |
+
+#### Returns
+
+`string`
+
+- Um hash calculado com base no valor informado.
+
+#### Defined in
+
+src/utils/StringUtils.ts:132
+
+___
+
+### isEmpty
+
+▸ `Static` **isEmpty**(`value`): `Boolean`
+
+Retorna se a string está vazia.
+Valores null e undefined são considerados como vazio.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `any` | String para ser validada. |
+
+#### Returns
+
+`Boolean`
+
+- Verdadeiro caso a string não contenha informação.
+
+#### Defined in
+
+src/utils/StringUtils.ts:16
+
+___
+
+### padEnd
+
+▸ `Static` **padEnd**(`str`, `len`, `pad?`): `string`
+
+Adiciona caracteres à direita caso texto seja menor que o valor do parâmetro len passado.
+
+**`Example`**
+
+```ts
+padStart('SANKHYA', 8,'.') | Retorna: 'SANKHYA...'
+```
+
+**`Example`**
+
+```ts
+padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `str` | `string` | `undefined` | Texto para ser ajustado. |
+| `len` | `number` | `undefined` | Tamanho desejado do texto. |
+| `pad` | `string` | `" "` | Caractere a ser adicionado a direita caso o texto menor que o tamanho passado. |
+
+#### Returns
+
+`string`
+
+- Texto passado se este for maior que o len.
+Ou retorna o texto com os caracteres adicionados na direita.
+
+#### Defined in
+
+src/utils/StringUtils.ts:207
+
+___
+
+### padStart
+
+▸ `Static` **padStart**(`str`, `len`, `pad?`): `string`
+
+Adiciona caracteres à esquerda caso texto seja menor que o valor do parâmetro len passado.
+
+**`Example`**
+
+```ts
+padStart('SANKHYA', 8,'.') | Retorna: '...SANKHYA'
+```
+
+**`Example`**
+
+```ts
+padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `str` | `string` | `undefined` | Texto para ser ajustado. |
+| `len` | `number` | `undefined` | Tamanho desejado do texto. |
+| `pad` | `string` | `" "` | Caractere a ser adicionado a esquerda caso o texto menor que o tamanho passado. |
+
+#### Returns
+
+`string`
+
+- Texto passado se este for maior que o len.
+Ou retorna o texto com os caracteres adicionados na esquerda.
+
+#### Defined in
+
+src/utils/StringUtils.ts:182
+
+___
+
+### prettyPrecision
+
+▸ `Static` `Private` **prettyPrecision**(`strNumber`): `string`
+
+Método interno. Remove zeros depois da vírgula diminuindo o tamanho
+da string.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `strNumber` | `string` | representação textual do número a ser ajustado. |
+
+#### Returns
+
+`string`
+
+simplificação do strNumber, sem os zeros à direita depois do ponto.
+
+#### Defined in
+
+src/utils/StringUtils.ts:334
+
+___
+
+### replaceAccentuatedChars
+
+▸ `Static` **replaceAccentuatedChars**(`text`, `removeSpecialChars?`): `string`
+
+Remove acentuação de vogais e de caracteres especiais que não sejam letras ou numeral.
+
+**`Example`**
+
+```ts
+entrada: "á@Êç#Ò", false // retorno: "a@Ec#O"
+entrada: "á@Êç#Ò", true // retorno: "aEcO"
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `text` | `string` | `undefined` | String para ser transformada. |
+| `removeSpecialChars` | `boolean` | `true` | Remove outros caracteres especiais que não sejam letras e números. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:105
+
+___
+
+### replaceAccentuatedCharsKeepSymbols
+
+▸ `Static` **replaceAccentuatedCharsKeepSymbols**(`text`): `string`
+
+Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta mantendo espaços e símbolos.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | Texto para ser transformado. |
+
+#### Returns
+
+`string`
+
+- Texto sem acentuação e caixa alta, mantendo espaços e símbolos.
+
+#### Defined in
+
+src/utils/StringUtils.ts:121
+
+___
+
+### replaceAccentuatedCharsLower
+
+▸ `Static` **replaceAccentuatedCharsLower**(`text`): `string`
+
+Remove acentos de vogais minúsculas.
+
+**`Example`**
+
+```ts
+entrada: "áêçò" // retorno: "aeco"
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | String para ser transformada. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:85
+
+___
+
+### replaceAccentuatedCharsUpper
+
+▸ `Static` **replaceAccentuatedCharsUpper**(`text`): `string`
+
+Remove acentos de vogais maiúsculas
+
+**`Example`**
+
+```ts
+entrada: "ÁÊÇÒ" // retorno: "AECO"
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | String para ser transformada. |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:38
+
+___
+
+### replaceBlankCharacters
+
+▸ `Static` **replaceBlankCharacters**(`value`): `string`
+
+Utilitário para remover caracteres em branco da string.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String a ser removido os espaços. |
+
+#### Returns
+
+`string`
+
+String sem espaços em branco.
+
+#### Defined in
+
+src/utils/StringUtils.ts:298
+
+___
+
+### toCamelCase
+
+▸ `Static` **toCamelCase**(`value`): `string`
+
+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.
+
+**`Example`**
+
+```ts
+toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String a ser convertida. |
+
+#### Returns
+
+`string`
+
+String convertida em camelCase.
+
+#### Defined in
+
+src/utils/StringUtils.ts:249
+
+___
+
+### toKebabCase
+
+▸ `Static` **toKebabCase**(`value`): `string`
+
+Utilitário para converter string em kebab-case.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String a ser convertida. |
+
+#### Returns
+
+`string`
+
+String convertida em KebabCase.
+
+#### Defined in
+
+src/utils/StringUtils.ts:289
+
+___
+
+### toPascalCase
+
+▸ `Static` **toPascalCase**(`value`): `string`
+
+Converte string para PascalCase.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String a ser convertida. |
+
+#### Returns
+
+`string`
+
+String convertida em PascalCase.
+
+#### Defined in
+
+src/utils/StringUtils.ts:264
+
+___
+
+### toSnakeCase
+
+▸ `Static` **toSnakeCase**(`value`): `string`
+
+Utilitário para converter string em snake_case.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | String a ser convertida. |
+
+#### Returns
+
+`string`
+
+String convertida em snake_case.
+
+#### Defined in
+
+src/utils/StringUtils.ts:276

package/classes/TimeFormatter.md

@@ -0,0 +1,98 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / TimeFormatter
+
+# Class: TimeFormatter
+
+`TimeFormatter`: Utilizado para formatar horas.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](TimeFormatter.md#constructor)
+
+### Properties
+
+- [\_maskFormatter](TimeFormatter.md#_maskformatter)
+
+### Methods
+
+- [prepareValue](TimeFormatter.md#preparevalue)
+- [validateTime](TimeFormatter.md#validatetime)
+
+## Constructors
+
+### constructor
+
+• **new TimeFormatter**()
+
+## Properties
+
+### \_maskFormatter
+
+▪ `Static` **\_maskFormatter**: [`MaskFormatter`](MaskFormatter-1.md)
+
+#### Defined in
+
+src/utils/TimeFormatter.ts:8
+
+## Methods
+
+### prepareValue
+
+▸ `Static` **prepareValue**(`value`, `showSeconds`): `string`
+
+Converte um texto para o formato de hora.
+
+**`Exemples`**
+
+@"1012"       |       "10:12"
+@"10:12"      |       "10:12:00"
+@"100112"     |       "10:01:12"
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | Texto não formatado. |
+| `showSeconds` | `boolean` | Se será validado os segundos. |
+
+#### Returns
+
+`string`
+
+- Texto em formato de hora.
+
+#### Defined in
+
+src/utils/TimeFormatter.ts:22
+
+___
+
+### validateTime
+
+▸ `Static` **validateTime**(`value`, `showSeconds`): `boolean`
+
+Retorna se o texto está no formato de hora.
+
+**`Exemples`**
+
+@"1012"       |       true
+@"14e4"       |       false
+@"2624"       |       false
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | Texto a ser validado. |
+| `showSeconds` | `boolean` | Se será validado os segundos. |
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro para valores no formato de hora e False para formatos diferentes.
+
+#### Defined in
+
+src/utils/TimeFormatter.ts:64

package/classes/UserAgentUtils.md

@@ -0,0 +1,58 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UserAgentUtils
+
+# Class: UserAgentUtils
+
+`UserAgentUtils`: Utilitario para tratativas relacionadas ao navegador.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](UserAgentUtils.md#constructor)
+
+### Methods
+
+- [getBrowserInfo](UserAgentUtils.md#getbrowserinfo)
+- [isFirefox](UserAgentUtils.md#isfirefox)
+
+## Constructors
+
+### constructor
+
+• **new UserAgentUtils**()
+
+## Methods
+
+### getBrowserInfo
+
+▸ `Static` **getBrowserInfo**(): `any`
+
+Obtém nome e versão do navegador que está sendo utilizado.
+
+#### Returns
+
+`any`
+
+Objeto com o nome e versão do navegador.
+
+#### Defined in
+
+src/utils/UserAgentUtils/index.ts:22
+
+___
+
+### isFirefox
+
+▸ `Static` **isFirefox**(): `boolean`
+
+Obtém se o navegador do usuário é o firefox.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se o navegador do usuário for o firefox.
+
+#### Defined in
+
+src/utils/UserAgentUtils/index.ts:13