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

package/classes/DataUnitAction.md

@@ -0,0 +1,96 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitAction
+
+# Class: DataUnitAction
+
+## Implements
+
+- `StateAction`
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DataUnitAction.md#constructor)
+
+### Properties
+
+- [\_payload](DataUnitAction.md#_payload)
+- [\_type](DataUnitAction.md#_type)
+
+### Accessors
+
+- [payload](DataUnitAction.md#payload)
+- [type](DataUnitAction.md#type)
+
+## Constructors
+
+### constructor
+
+• **new DataUnitAction**(`type`, `payload?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | [`Action`](../enums/Action.md) |
+| `payload?` | `any` |
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:9
+
+## Properties
+
+### \_payload
+
+• `Private` **\_payload**: `any`
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:7
+
+___
+
+### \_type
+
+• `Private` **\_type**: [`Action`](../enums/Action.md)
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:6
+
+## Accessors
+
+### payload
+
+• `get` **payload**(): `any`
+
+#### Returns
+
+`any`
+
+#### Implementation of
+
+StateAction.payload
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:18
+
+___
+
+### type
+
+• `get` **type**(): [`Action`](../enums/Action.md)
+
+#### Returns
+
+[`Action`](../enums/Action.md)
+
+#### Implementation of
+
+StateAction.type
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:14

package/classes/DataUnitStorage.md

@@ -0,0 +1,116 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitStorage
+
+# Class: DataUnitStorage
+
+Classe responsável por armazenar instâncias de DataUnit.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DataUnitStorage.md#constructor)
+
+### Properties
+
+- [dataUnitMap](DataUnitStorage.md#dataunitmap)
+- [keyMap](DataUnitStorage.md#keymap)
+
+### Methods
+
+- [get](DataUnitStorage.md#get)
+- [put](DataUnitStorage.md#put)
+- [remove](DataUnitStorage.md#remove)
+
+## Constructors
+
+### constructor
+
+• **new DataUnitStorage**()
+
+## Properties
+
+### dataUnitMap
+
+▪ `Static` `Private` **dataUnitMap**: `WeakMap`<{ `key`: `string`  }, [`DataUnit`](DataUnit.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnitStorage.ts:7
+
+___
+
+### keyMap
+
+▪ `Static` `Private` **keyMap**: `Map`<`string`, { `key`: `string`  }\>
+
+#### Defined in
+
+src/dataunit/DataUnitStorage.ts:8
+
+## Methods
+
+### get
+
+▸ `Static` **get**(`dataUnitName`): `undefined` \| [`DataUnit`](DataUnit.md)
+
+Retorna uma instância de DataUnit armazenada no DataUnitStorage.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dataUnitName` | `string` | O nome do DataUnit. |
+
+#### Returns
+
+`undefined` \| [`DataUnit`](DataUnit.md)
+
+- A instância do DataUnit ou undefined caso não seja encontrada.
+
+#### Defined in
+
+src/dataunit/DataUnitStorage.ts:15
+
+___
+
+### put
+
+▸ `Static` **put**(`dataUnit`): `void`
+
+Armazena uma instância de DataUnit no DataUnitStorage.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) | A instância de DataUnit a ser armazenada. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnitStorage.ts:24
+
+___
+
+### remove
+
+▸ `Static` **remove**(`dataUnit`): `void`
+
+Remove uma instância de DataUnit do DataUnitStorage.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dataUnit` | `string` \| [`DataUnit`](DataUnit.md) | A instância de DataUnit ou o nome do DataUnit a ser removido. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnitStorage.ts:34

package/classes/DateUtils.md

@@ -0,0 +1,327 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DateUtils
+
+# Class: DateUtils
+
+`DateUtils`: Utilizado para formatação, padronização e cálculos de datas.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DateUtils.md#constructor)
+
+### Methods
+
+- [adjustDLST](DateUtils.md#adjustdlst)
+- [clearTime](DateUtils.md#cleartime)
+- [formatDate](DateUtils.md#formatdate)
+- [formatDateTime](DateUtils.md#formatdatetime)
+- [formatRfc3339](DateUtils.md#formatrfc3339)
+- [formatTime](DateUtils.md#formattime)
+- [getToday](DateUtils.md#gettoday)
+- [pad](DateUtils.md#pad)
+- [strToDate](DateUtils.md#strtodate)
+- [timezoneOffset](DateUtils.md#timezoneoffset)
+- [validateDate](DateUtils.md#validatedate)
+
+## Constructors
+
+### constructor
+
+• **new DateUtils**()
+
+## Methods
+
+### adjustDLST
+
+▸ `Static` `Private` **adjustDLST**(`date`): `Date`
+
+Realiza correção do horário de verão.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date` | `Date` | Data a ser ajustada. |
+
+#### Returns
+
+`Date`
+
+- Data informada ajustada para horário de verão.
+
+#### Defined in
+
+src/utils/DateUtils.ts:135
+
+___
+
+### clearTime
+
+▸ `Static` **clearTime**(`date`, `adjustDayLightSavingTime?`): `Date`
+
+Zerar o horário de uma data.
+
+**`Example`**
+
+```ts
+Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `date` | `Date` | `undefined` | Data a ser manipulada. |
+| `adjustDayLightSavingTime` | `boolean` | `true` | Ajusta horário de verão na data recebida. |
+
+#### Returns
+
+`Date`
+
+- Data sem as informações de horário.
+
+#### Defined in
+
+src/utils/DateUtils.ts:17
+
+___
+
+### formatDate
+
+▸ `Static` **formatDate**(`date`, `options?`): `string`
+
+Converte data para uma string no formato pt-BR.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date` | `Date` | Data a ser convertida. |
+| `options?` | `DateTimeFormatOptions` | Opções de formatação da data. |
+
+#### Returns
+
+`string`
+
+- Uma string com a data no formato pt-BR DD/MM/YYYY.
+
+#### Defined in
+
+src/utils/DateUtils.ts:29
+
+___
+
+### formatDateTime
+
+▸ `Static` **formatDateTime**(`date`, `showSeconds?`): `string`
+
+Converte a data e hora para uma string no formato pt-BR.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `date` | `Date` | `undefined` | Data a ser convertida. |
+| `showSeconds` | `boolean` | `false` | define se devemos considerar os segundos. |
+
+#### Returns
+
+`string`
+
+- Uma string com as horas no formato DD/MM/YYYY HH:MM ou DD/MM/YYYY HH:MM:SS.
+
+#### Defined in
+
+src/utils/DateUtils.ts:52
+
+___
+
+### formatRfc3339
+
+▸ `Static` **formatRfc3339**(`date`): `string`
+
+Converte a data para o formato RFC3339.
+
+**`Example`**
+
+```ts
+Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date` | `Date` | Data a ser convertida |
+
+#### Returns
+
+`string`
+
+- Data informada no formato RFC3339.
+*
+
+#### Defined in
+
+src/utils/DateUtils.ts:185
+
+___
+
+### formatTime
+
+▸ `Static` **formatTime**(`date`, `showSeconds?`): `string`
+
+Converte as horas de uma data para uma string pt-BR.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `date` | `Date` | `undefined` | Data a ser convertida. |
+| `showSeconds` | `boolean` | `false` | define se devemos considerar os segundos. |
+
+#### Returns
+
+`string`
+
+- Uma string com as horas no formato HH:MM ou HH:MM:SS.
+
+#### Defined in
+
+src/utils/DateUtils.ts:40
+
+___
+
+### getToday
+
+▸ `Static` **getToday**(`withTime?`): `Date`
+
+Obtém a data atual.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `withTime` | `boolean` | `false` | Caso true retorna a data com informações de horário. |
+
+#### Returns
+
+`Date`
+
+- Data atual sem informação de horário.
+
+#### Defined in
+
+src/utils/DateUtils.ts:106
+
+___
+
+### pad
+
+▸ `Static` `Private` **pad**(`n`): `string` \| `number`
+
+Adiciona uma casa decimal a esquerda de uma unidade.
+
+**`Example`**
+
+```ts
+Informo: 15     | Obtenho: 15
+```
+
+**`Example`**
+
+```ts
+Informo:  2     | Obtenho: "02"
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `n` | `number` | Número a ser ajustado |
+
+#### Returns
+
+`string` \| `number`
+
+- O número informado, com uma casa decimal a esquerda.
+
+#### Defined in
+
+src/utils/DateUtils.ts:154
+
+___
+
+### strToDate
+
+▸ `Static` **strToDate**(`strValue`, `adjustDayLightSavingTime?`, `monthYearMode?`): `undefined` \| `Date`
+
+Converte String para Date.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `strValue` | `string` | `undefined` | Texto a ser convertido para data. |
+| `adjustDayLightSavingTime` | `boolean` | `true` | Se verdadeiro, ativa regra de horário de verão. |
+| `monthYearMode` | `boolean` | `false` | Quando ativado, retorna o primeiro dia do mês apenas para construir a data. |
+
+#### Returns
+
+`undefined` \| `Date`
+
+- Data sem as informações de horário.
+
+#### Defined in
+
+src/utils/DateUtils.ts:64
+
+___
+
+### timezoneOffset
+
+▸ `Static` `Private` **timezoneOffset**(`offset`): `string`
+
+Retorna timezone da data.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `offset` | `number` | Valor do timezone desejado. |
+
+#### Returns
+
+`string`
+
+Timezone da data.
+
+#### Defined in
+
+src/utils/DateUtils.ts:164
+
+___
+
+### validateDate
+
+▸ `Static` **validateDate**(`value`, `hasTime?`): `undefined` \| `Date`
+
+Retorna se a data é válida.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `Date` | `undefined` | Data a ser validada. |
+| `hasTime` | `boolean` | `false` | Determina se a data retornada deve conter informação de horário ou não. Por padrão não retorna a hora. |
+
+#### Returns
+
+`undefined` \| `Date`
+
+- Caso válida, retorna a própria data.
+
+#### Defined in
+
+src/utils/DateUtils.ts:123