@sankhyalabs/core-docs 2.3.0 → 2.3.1-SKA-61927.2

package/classes/RequestMetadata.md

@@ -1,84 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / RequestMetadata
-
-# Class: RequestMetadata
-
-Representa as propriedades necessárias para se executar uma requisição.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RequestMetadata.md#constructor)
-
-### Properties
-
-- [headers](RequestMetadata.md#headers)
-- [method](RequestMetadata.md#method)
-- [timeout](RequestMetadata.md#timeout)
-- [url](RequestMetadata.md#url)
-
-## Constructors
-
-### constructor
-
-• **new RequestMetadata**(`url`, `method`, `headers?`)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `url` | `string` | A URL que deve ser chamada. |
-| `method` | `Method` | O Método da requisição (GET, PUT, POST ou DELETE). |
-| `headers?` | `Header`[] | - |
-
-#### Defined in
-
-src/http/RequestMetadata.ts:22
-
-## Properties
-
-### headers
-
-• **headers**: `Header`[]
-
-Headers para serem enviados na requisição
-
-#### Defined in
-
-src/http/RequestMetadata.ts:16
-
-___
-
-### method
-
-• **method**: `Method`
-
-O verbo HTTP
-
-#### Defined in
-
-src/http/RequestMetadata.ts:10
-
-___
-
-### timeout
-
-• **timeout**: `number` = `30000`
-
-Tempo limite de espera pela resposta
-
-#### Defined in
-
-src/http/RequestMetadata.ts:13
-
-___
-
-### url
-
-• **url**: `string`
-
-A URL a ser chamada
-
-#### Defined in
-
-src/http/RequestMetadata.ts:7

package/classes/SkwHttpProvider.md

@@ -1,109 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SkwHttpProvider
-
-# Class: SkwHttpProvider
-
-## Table of contents
-
-### Constructors
-
-- [constructor](SkwHttpProvider.md#constructor)
-
-### Properties
-
-- [STATUS\_CANCELED](SkwHttpProvider.md#status_canceled)
-- [STATUS\_ERROR](SkwHttpProvider.md#status_error)
-- [STATUS\_INFO](SkwHttpProvider.md#status_info)
-- [STATUS\_OK](SkwHttpProvider.md#status_ok)
-- [STATUS\_TIMEOUT](SkwHttpProvider.md#status_timeout)
-- [\_counter](SkwHttpProvider.md#_counter)
-
-### Methods
-
-- [callService](SkwHttpProvider.md#callservice)
-
-## Constructors
-
-### constructor
-
-• **new SkwHttpProvider**()
-
-## Properties
-
-### STATUS\_CANCELED
-
-▪ `Static` **STATUS\_CANCELED**: `number` = `4`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:11
-
-___
-
-### STATUS\_ERROR
-
-▪ `Static` **STATUS\_ERROR**: `number` = `0`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:7
-
-___
-
-### STATUS\_INFO
-
-▪ `Static` **STATUS\_INFO**: `number` = `2`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:9
-
-___
-
-### STATUS\_OK
-
-▪ `Static` **STATUS\_OK**: `number` = `1`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:8
-
-___
-
-### STATUS\_TIMEOUT
-
-▪ `Static` **STATUS\_TIMEOUT**: `number` = `3`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:10
-
-___
-
-### \_counter
-
-▪ `Static` **\_counter**: `number` = `0`
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:5
-
-## Methods
-
-### callService
-
-▸ `Static` **callService**(`serviceName`, `content`): `Promise`<`Object`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `serviceName` | `string` |
-| `content` | `Object` |
-
-#### Returns
-
-`Promise`<`Object`\>
-
-#### Defined in
-
-src/http/SkwHttpProvider.ts:13

package/classes/StringUtils.md

@@ -1,315 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / StringUtils
-
-# Class: StringUtils
-
-Classe com utiliários comuns para Strings.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](StringUtils.md#constructor)
-
-### Methods
-
-- [compare](StringUtils.md#compare)
-- [getBooleanValue](StringUtils.md#getbooleanvalue)
-- [hashCode](StringUtils.md#hashcode)
-- [isEmpty](StringUtils.md#isempty)
-- [padEnd](StringUtils.md#padend)
-- [padStart](StringUtils.md#padstart)
-- [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
-- [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
-- [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`
-
-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.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `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.
-
-#### Defined in
-
-src/utils/StringUtils.ts:126
-
-___
-
-### getBooleanValue
-
-▸ `Static` **getBooleanValue**(`value`, `defaultValue?`): `boolean`
-
-Converte um valor em string para booleano
-
-#### 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") |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-src/utils/StringUtils.ts:89
-
-___
-
-### hashCode
-
-▸ `Static` **hashCode**(`value`): `string`
-
-Calcula um código hash para uma string.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | String que será gerado o hash code. |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/StringUtils.ts:73
-
-___
-
-### isEmpty
-
-▸ `Static` **isEmpty**(`value`): `Boolean`
-
-Verifica 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`
-
-#### Defined in
-
-src/utils/StringUtils.ts:12
-
-___
-
-### padEnd
-
-▸ `Static` **padEnd**(`str`, `len`, `pad?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `str` | `string` | `undefined` |
-| `len` | `number` | `undefined` |
-| `pad` | `string` | `" "` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/StringUtils.ts:109
-
-___
-
-### padStart
-
-▸ `Static` **padStart**(`str`, `len`, `pad?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `str` | `string` | `undefined` |
-| `len` | `number` | `undefined` |
-| `pad` | `string` | `" "` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/StringUtils.ts:101
-
-___
-
-### replaceAccentuatedChars
-
-▸ `Static` **replaceAccentuatedChars**(`text`): `string`
-
-Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/StringUtils.ts:34
-
-___
-
-### 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` | String para ser transformada. |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/StringUtils.ts:65
-
-___
-
-### toCamelCase
-
-▸ `Static` **toCamelCase**(`value`): `string`
-
-Utilitário para converter 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.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
-
-#### Returns
-
-`string`
-
-String convertida em camelCase
-
-#### Defined in
-
-src/utils/StringUtils.ts:149
-
-___
-
-### toKebabCase
-
-▸ `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
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
-
-#### Returns
-
-`string`
-
-String convertida em KebabCase
-
-#### Defined in
-
-src/utils/StringUtils.ts:192
-
-___
-
-### toPascalCase
-
-▸ `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
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
-
-#### Returns
-
-`string`
-
-String convertida em PascalCase
-
-#### Defined in
-
-src/utils/StringUtils.ts:165
-
-___
-
-### toSnakeCase
-
-▸ `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
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | String a ser convertida |
-
-#### Returns
-
-`string`
-
-String convertida em snake_case
-
-#### Defined in
-
-src/utils/StringUtils.ts:178

package/classes/TimeFormatter.md

@@ -1,98 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / TimeFormatter
-
-# Class: TimeFormatter
-
-`TimeFormatter` é um utilitário para formatação de strings desformatadas em strings válidas de horários
-
-## 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`
-
-@prepareValue: converts an unformated time string into a formatted time.
-
-**`Exemples`**
-
-@"1012"       |       "10:12"
-@"10:12"      |       "10:12:00"
-@"100112"     |       "10:01:12"
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | unformated time string to convert |
-| `showSeconds` | `boolean` | - |
-
-#### Returns
-
-`string`
-
-formatted time string
-
-#### Defined in
-
-src/utils/TimeFormatter.ts:22
-
-___
-
-### validateTime
-
-▸ `Static` **validateTime**(`value`, `showSeconds`): `boolean`
-
-@validateTime: validates if an input string has the corect time format.
-
-**`Exemples`**
-
-@"1012"       |       true
-@"14e4"       |       false
-@"2624"       |       false
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | input string to validate |
-| `showSeconds` | `boolean` | - |
-
-#### Returns
-
-`boolean`
-
-true or false
-
-#### Defined in
-
-src/utils/TimeFormatter.ts:64

package/classes/UserAgentUtils.md

@@ -1,48 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UserAgentUtils
-
-# Class: UserAgentUtils
-
-## 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`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-src/utils/UserAgentUtils/index.ts:10
-
-___
-
-### isFirefox
-
-▸ `Static` **isFirefox**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-src/utils/UserAgentUtils/index.ts:5