@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6

package/classes/TimeFormatter.md

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

package/classes/UserAgentUtils.md

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

package/classes/VersionUtils.md

@@ -1,42 +1,39 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / VersionUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: VersionUtils
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / VersionUtils
 
-### Constructors
+# Class: VersionUtils
 
-- [constructor](VersionUtils.md#constructor)
+## Constructors
 
-### Methods
+### new VersionUtils()
 
-- [isRequiredVersion](VersionUtils.md#isrequiredversion)
+> **new VersionUtils**(): [`VersionUtils`](VersionUtils.md)
 
-## Constructors
-
-### constructor
+#### Returns
 
-• **new VersionUtils**()
+[`VersionUtils`](VersionUtils.md)
 
 ## Methods
 
-### isRequiredVersion
+### isRequiredVersion()
 
-▸ `Static` **isRequiredVersion**(`currentVersion`, `requiredVersion`): `boolean`
+> `static` **isRequiredVersion**(`currentVersion`, `requiredVersion`): `boolean`
 
 Verifica se a versão do backend (SankhyaOM) é maior ou igual a uma determinada versão.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `currentVersion` | `string` |
-| `requiredVersion` | `string` |
+• **currentVersion**: `string`
+
+• **requiredVersion**: `string`
 
 #### Returns
 
 `boolean`
 
-#### Defined in
+#### Source
 
 src/utils/VersionUtils.ts:8

package/classes/WaitingChangeException.md

@@ -1,191 +1,170 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChangeException
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / WaitingChangeException
 
 # Class: WaitingChangeException
 
 `WaitingChangeException`: Exceção lançada quando um campo está pendente de finalizar a alteração antes de executar uma ação.
 
-## Hierarchy
+## Extends
 
 - `Error`
 
-  ↳ **`WaitingChangeException`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](WaitingChangeException.md#constructor)
-
-### Properties
-
-- [cause](WaitingChangeException.md#cause)
-- [message](WaitingChangeException.md#message)
-- [name](WaitingChangeException.md#name)
-- [stack](WaitingChangeException.md#stack)
-- [title](WaitingChangeException.md#title)
-- [prepareStackTrace](WaitingChangeException.md#preparestacktrace)
-- [stackTraceLimit](WaitingChangeException.md#stacktracelimit)
+## Constructors
 
-### Methods
+### new WaitingChangeException()
 
-- [captureStackTrace](WaitingChangeException.md#capturestacktrace)
+> **new WaitingChangeException**(`title`, `message`): [`WaitingChangeException`](WaitingChangeException.md)
 
-## Constructors
+#### Parameters
 
-### constructor
+• **title**: `string`
 
-• **new WaitingChangeException**(`title`, `message`)
+• **message**: `string`
 
-#### Parameters
+#### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `title` | `string` |
-| `message` | `string` |
+[`WaitingChangeException`](WaitingChangeException.md)
 
 #### Overrides
 
-Error.constructor
+`Error.constructor`
 
-#### Defined in
+#### Source
 
 src/exceptions/WaitingChangeException.ts:15
 
 ## Properties
 
-### cause
+### cause?
 
-• `Optional` **cause**: `unknown`
+> `optional` **cause**: `unknown`
 
 #### Inherited from
 
-Error.cause
+`Error.cause`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.es2022.error.d.ts:26
+node\_modules/typescript/lib/lib.es2022.error.d.ts:26
 
-___
+***
 
 ### message
 
-• **message**: `string`
+> **message**: `string`
 
 Descrição do erro.
 
 #### Overrides
 
-Error.message
+`Error.message`
 
-#### Defined in
+#### Source
 
 src/exceptions/WaitingChangeException.ts:13
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Nome da exceção.
 
 #### Overrides
 
-Error.name
+`Error.name`
 
-#### Defined in
+#### Source
 
 src/exceptions/WaitingChangeException.ts:7
 
-___
+***
 
-### stack
+### stack?
 
-• `Optional` **stack**: `string`
+> `optional` **stack**: `string`
 
 #### Inherited from
 
-Error.stack
+`Error.stack`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.es5.d.ts:1055
+node\_modules/typescript/lib/lib.es5.d.ts:1055
 
-___
+***
 
 ### title
 
-• **title**: `string`
+> **title**: `string`
 
 Titulo do erro.
 
-#### Defined in
+#### Source
 
 src/exceptions/WaitingChangeException.ts:10
 
-___
-
-### prepareStackTrace
+***
 
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+### prepareStackTrace()?
 
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
 
 Optional override for formatting stack traces
 
-**`See`**
+#### See
 
 https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
-##### Parameters
+#### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
+• **err**: `Error`
 
-##### Returns
+• **stackTraces**: `CallSite`[]
+
+#### Returns
 
 `any`
 
 #### Inherited from
 
-Error.prepareStackTrace
+`Error.prepareStackTrace`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:11
+node\_modules/@types/node/globals.d.ts:27
 
-___
+***
 
 ### stackTraceLimit
 
-▪ `Static` **stackTraceLimit**: `number`
+> `static` **stackTraceLimit**: `number`
 
 #### Inherited from
 
-Error.stackTraceLimit
+`Error.stackTraceLimit`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:13
+node\_modules/@types/node/globals.d.ts:29
 
 ## Methods
 
-### captureStackTrace
+### captureStackTrace()
 
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
 Create .stack property on a target object
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
 
 #### Returns
 
@@ -193,8 +172,8 @@ Create .stack property on a target object
 
 #### Inherited from
 
-Error.captureStackTrace
+`Error.captureStackTrace`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:4
+node\_modules/@types/node/globals.d.ts:20