@sankhyalabs/core-docs 2.3.6 → 2.4.0

package/classes/StringUtils.md

@@ -2,7 +2,7 @@
 
 # Class: StringUtils
 
-Classe com utiliários comuns para Strings.
+`StringUtils`: Utilizado para manipulação de Strings.
 
 ## Table of contents
 
@@ -40,26 +40,24 @@ Classe com utiliários comuns para Strings.
 
 ▸ `Static` **compare**(`a`, `b`): `number`
 
-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.
+Determina a ordem de strings.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `a` | `string` | Primeira string para comparação |
-| `b` | `string` | Segunda string para comparação |
+| `a` | `string` | Primeira string para comparação. |
+| `b` | `string` | Segunda string para comparação. |
 
 #### Returns
 
 `number`
 
-Um valor maior, menor ou igual a zero para determinar se a ordem precisa ser alterada.
+- 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:174
+src/utils/StringUtils.ts:218
 
 ___
 
@@ -87,7 +85,7 @@ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
 
 #### Defined in
 
-src/utils/StringUtils.ts:51
+src/utils/StringUtils.ts:53
 
 ___
 
@@ -95,22 +93,31 @@ ___
 
 ▸ `Static` **getBooleanValue**(`value`, `defaultValue?`): `boolean`
 
-Converte um valor em string para booleano
+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` | Será retornado esse caso seja passado valores diferentes do esperado(true, false, "true", "false", "S", "N") |
+| `value` | `string` | `undefined` | Valor a ser convertido. |
+| `defaultValue` | `boolean` | `false` | Valor padrão. |
 
 #### Returns
 
 `boolean`
 
+- Texto convertido.
+
 #### Defined in
 
-src/utils/StringUtils.ts:137
+src/utils/StringUtils.ts:148
 
 ___
 
@@ -120,6 +127,12 @@ ___
 
 Calcula um código hash para uma string.
 
+**`Example`**
+
+```ts
+Informado: '123456' | Retorna: 1450575459
+```
+
 #### Parameters
 
 | Name | Type | Description |
@@ -130,9 +143,11 @@ Calcula um código hash para uma string.
 
 `string`
 
+- Um hash calculado com base no valor informado.
+
 #### Defined in
 
-src/utils/StringUtils.ts:121
+src/utils/StringUtils.ts:127
 
 ___
 
@@ -140,7 +155,7 @@ ___
 
 ▸ `Static` **isEmpty**(`value`): `Boolean`
 
-Verifica se a string está vazia.
+Retorna se a string está vazia.
 Valores null e undefined são considerados como vazio.
 
 #### Parameters
@@ -153,9 +168,11 @@ Valores null e undefined são considerados como vazio.
 
 `Boolean`
 
+- Verdadeiro caso a string não contenha informação.
+
 #### Defined in
 
-src/utils/StringUtils.ts:12
+src/utils/StringUtils.ts:14
 
 ___
 
@@ -163,21 +180,38 @@ ___
 
 ▸ `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 |
-| :------ | :------ | :------ |
-| `str` | `string` | `undefined` |
-| `len` | `number` | `undefined` |
-| `pad` | `string` | `" "` |
+| 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:157
+src/utils/StringUtils.ts:202
 
 ___
 
@@ -185,21 +219,38 @@ ___
 
 ▸ `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 |
-| :------ | :------ | :------ |
-| `str` | `string` | `undefined` |
-| `len` | `number` | `undefined` |
-| `pad` | `string` | `" "` |
+| 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:149
+src/utils/StringUtils.ts:177
 
 ___
 
@@ -229,7 +280,7 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
 
 #### Defined in
 
-src/utils/StringUtils.ts:98
+src/utils/StringUtils.ts:100
 
 ___
 
@@ -243,15 +294,17 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `text` | `string` | String para ser transformada. |
+| `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:113
+src/utils/StringUtils.ts:116
 
 ___
 
@@ -279,7 +332,7 @@ entrada: "áêçò" // retorno: "aeco"
 
 #### Defined in
 
-src/utils/StringUtils.ts:78
+src/utils/StringUtils.ts:80
 
 ___
 
@@ -307,7 +360,7 @@ entrada: "ÁÊÇÒ" // retorno: "AECO"
 
 #### Defined in
 
-src/utils/StringUtils.ts:34
+src/utils/StringUtils.ts:36
 
 ___
 
@@ -315,24 +368,30 @@ ___
 
 ▸ `Static` **toCamelCase**(`value`): `string`
 
-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.
 
+**`Example`**
+
+```ts
+toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
+```
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
+| `value` | `string` | String a ser convertida. |
 
 #### Returns
 
 `string`
 
-String convertida em camelCase
+String convertida em camelCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:197
+src/utils/StringUtils.ts:244
 
 ___
 
@@ -340,24 +399,23 @@ ___
 
 ▸ `Static` **toKebabCase**(`value`): `string`
 
-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
+Utilitário para converter string em kebab-case.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
+| `value` | `string` | String a ser convertida. |
 
 #### Returns
 
 `string`
 
-String convertida em KebabCase
+String convertida em KebabCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:240
+src/utils/StringUtils.ts:284
 
 ___
 
@@ -365,24 +423,23 @@ ___
 
 ▸ `Static` **toPascalCase**(`value`): `string`
 
-Utilitário para converter string em PascalCase 
-Combina palavras colocando todas as palavras em minúsculas (mesmo a primeira palavra) removendo espaços
+Converte string para PascalCase.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
+| `value` | `string` | String a ser convertida. |
 
 #### Returns
 
 `string`
 
-String convertida em PascalCase
+String convertida em PascalCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:213
+src/utils/StringUtils.ts:259
 
 ___
 
@@ -390,21 +447,20 @@ ___
 
 ▸ `Static` **toSnakeCase**(`value`): `string`
 
-Utilitário para converter string em snake_case
-Combina palavras substituindo cada espaço por um unsderscore (_) convertendo todas as letras para minúsculas
+Utilitário para converter string em snake_case.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
+| `value` | `string` | String a ser convertida. |
 
 #### Returns
 
 `string`
 
-String convertida em snake_case
+String convertida em snake_case.
 
 #### Defined in
 
-src/utils/StringUtils.ts:226
+src/utils/StringUtils.ts:271

package/classes/TimeFormatter.md

@@ -2,7 +2,7 @@
 
 # Class: TimeFormatter
 
-`TimeFormatter` é um utilitário para formatação de strings desformatadas em strings válidas de horários
+`TimeFormatter`: Utilizado para formatar horas.
 
 ## Table of contents
 
@@ -41,7 +41,7 @@ src/utils/TimeFormatter.ts:8
 
 ▸ `Static` **prepareValue**(`value`, `showSeconds`): `string`
 
-@prepareValue: converts an unformated time string into a formatted time.
+Converte um texto para o formato de hora.
 
 **`Exemples`**
 
@@ -53,14 +53,14 @@ src/utils/TimeFormatter.ts:8
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | unformated time string to convert |
-| `showSeconds` | `boolean` | - |
+| `value` | `string` | Texto não formatado. |
+| `showSeconds` | `boolean` | Se será validado os segundos. |
 
 #### Returns
 
 `string`
 
-formatted time string
+- Texto em formato de hora.
 
 #### Defined in
 
@@ -72,7 +72,7 @@ ___
 
 ▸ `Static` **validateTime**(`value`, `showSeconds`): `boolean`
 
-@validateTime: validates if an input string has the corect time format.
+Retorna se o texto está no formato de hora.
 
 **`Exemples`**
 
@@ -84,14 +84,14 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | input string to validate |
-| `showSeconds` | `boolean` | - |
+| `value` | `string` | Texto a ser validado. |
+| `showSeconds` | `boolean` | Se será validado os segundos. |
 
 #### Returns
 
 `boolean`
 
-true or false
+- Verdadeiro para valores no formato de hora e False para formatos diferentes.
 
 #### Defined in
 

package/classes/UserAgentUtils.md

@@ -2,6 +2,8 @@
 
 # Class: UserAgentUtils
 
+`UserAgentUtils`: Utilitario para tratativas relacionadas ao navegador.
+
 ## Table of contents
 
 ### Constructors
@@ -25,13 +27,17 @@
 
 ▸ `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:10
+src/utils/UserAgentUtils/index.ts:22
 
 ___
 
@@ -39,10 +45,14 @@ ___
 
 ▸ `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:5
+src/utils/UserAgentUtils/index.ts:13

package/classes/WaitingChangeException.md

@@ -2,6 +2,8 @@
 
 # Class: WaitingChangeException
 
+`WaitingChangeException`: Exceção lançada quando um campo está pendente de finalizar a alteração antes de executar uma ação.
+
 ## Hierarchy
 
 - `Error`
@@ -47,7 +49,7 @@ Error.constructor
 
 #### Defined in
 
-src/exceptions/WaitingChangeException.ts:7
+src/exceptions/WaitingChangeException.ts:12
 
 ## Properties
 
@@ -69,13 +71,15 @@ ___
 
 • **message**: `string`
 
+Descrição do erro.
+
 #### Overrides
 
 Error.message
 
 #### Defined in
 
-src/exceptions/WaitingChangeException.ts:5
+src/exceptions/WaitingChangeException.ts:10
 
 ___
 
@@ -111,9 +115,11 @@ ___
 
 • **title**: `string`
 
+Titulo do erro.
+
 #### Defined in
 
-src/exceptions/WaitingChangeException.ts:4
+src/exceptions/WaitingChangeException.ts:7
 
 ___
 

package/classes/WarningException.md

@@ -2,6 +2,8 @@
 
 # Class: WarningException
 
+`WarningException`: Exceção lançada quando o "erro" vindo do backend é caracterizado como warning.
+
 ## Hierarchy
 
 - `Error`
@@ -49,7 +51,7 @@ Error.constructor
 
 #### Defined in
 
-src/exceptions/WarningException.ts:8
+src/exceptions/WarningException.ts:15
 
 ## Properties
 
@@ -71,9 +73,11 @@ ___
 
 • **errorCode**: `string`
 
+Código do alerta, indica o alerta disparado pelo backend.
+
 #### Defined in
 
-src/exceptions/WarningException.ts:6
+src/exceptions/WarningException.ts:13
 
 ___
 
@@ -81,13 +85,15 @@ ___
 
 • **message**: `string`
 
+Descrição do alerta.
+
 #### Overrides
 
 Error.message
 
 #### Defined in
 
-src/exceptions/WarningException.ts:5
+src/exceptions/WarningException.ts:10
 
 ___
 
@@ -123,9 +129,11 @@ ___
 
 • **title**: `string`
 
+Titulo do alerta.
+
 #### Defined in
 
-src/exceptions/WarningException.ts:4
+src/exceptions/WarningException.ts:7
 
 ___
 

package/enums/ChangeOperation.md

@@ -19,7 +19,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:570
+src/dataunit/DataUnit.ts:1042
 
 ___
 
@@ -29,7 +29,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:572
+src/dataunit/DataUnit.ts:1044
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:569
+src/dataunit/DataUnit.ts:1041
 
 ___
 
@@ -49,4 +49,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:571
+src/dataunit/DataUnit.ts:1043

package/enums/DataType.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-src/dataunit/metadata/DataType.ts:7
+src/dataunit/metadata/DataType.ts:9
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-src/dataunit/metadata/DataType.ts:5
+src/dataunit/metadata/DataType.ts:7
 
 ___
 
@@ -40,7 +40,7 @@ ___
 
 #### Defined in
 
-src/dataunit/metadata/DataType.ts:4
+src/dataunit/metadata/DataType.ts:6
 
 ___
 
@@ -50,7 +50,7 @@ ___
 
 #### Defined in
 
-src/dataunit/metadata/DataType.ts:8
+src/dataunit/metadata/DataType.ts:10
 
 ___
 
@@ -60,4 +60,4 @@ ___
 
 #### Defined in
 
-src/dataunit/metadata/DataType.ts:6
+src/dataunit/metadata/DataType.ts:8

package/interfaces/DUActionInterceptor.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:555
+src/dataunit/DataUnit.ts:1027