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

package/classes/DateUtils.md

@@ -1,48 +1,36 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DateUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: DateUtils
-
-`DateUtils`: Utilizado para formatação, padronização e cálculos de datas.
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / DateUtils
 
-### Constructors
+# Class: DateUtils
 
-- [constructor](DateUtils.md#constructor)
+`DateUtils`: Utilizado para formatação, padronização e cálculos de datas.
 
-### Methods
+## Constructors
 
-- [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)
+### new DateUtils()
 
-## Constructors
+> **new DateUtils**(): [`DateUtils`](DateUtils.md)
 
-### constructor
+#### Returns
 
-• **new DateUtils**()
+[`DateUtils`](DateUtils.md)
 
 ## Methods
 
-### adjustDLST
+### adjustDLST()
 
-▸ `Static` `Private` **adjustDLST**(`date`): `Date`
+> `static` `private` **adjustDLST**(`date`): `Date`
 
 Realiza correção do horário de verão.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `date` | `Date` | Data a ser ajustada. |
+• **date**: `Date`
+
+Data a ser ajustada.
 
 #### Returns
 
@@ -50,30 +38,27 @@ Realiza correção do horário de verão.
 
 - Data informada ajustada para horário de verão.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:136
 
-___
+***
 
-### clearTime
+### clearTime()
 
-▸ `Static` **clearTime**(`date`, `adjustDayLightSavingTime?`): `Date`
+> `static` **clearTime**(`date`, `adjustDayLightSavingTime`): `Date`
 
 Zerar o horário de uma data.
 
-**`Example`**
+#### Parameters
 
-```ts
-Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
-```
+• **date**: `Date`
 
-#### Parameters
+Data a ser manipulada.
+
+• **adjustDayLightSavingTime**: `boolean`= `true`
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `date` | `Date` | `undefined` | Data a ser manipulada. |
-| `adjustDayLightSavingTime` | `boolean` | `true` | Ajusta horário de verão na data recebida. |
+Ajusta horário de verão na data recebida.
 
 #### Returns
 
@@ -81,24 +66,33 @@ Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
 
 - Data sem as informações de horário.
 
-#### Defined in
+#### Example
+
+```ts
+Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
+```
+
+#### Source
 
 src/utils/DateUtils.ts:15
 
-___
+***
 
-### formatDate
+### formatDate()
 
-▸ `Static` **formatDate**(`date`, `options?`): `string`
+> `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. |
+• **date**: `Date`
+
+Data a ser convertida.
+
+• **options?**: `DateTimeFormatOptions`
+
+Opções de formatação da data.
 
 #### Returns
 
@@ -106,24 +100,27 @@ Converte data para uma string no formato pt-BR.
 
 - Uma string com a data no formato pt-BR DD/MM/YYYY.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:27
 
-___
+***
 
-### formatDateTime
+### formatDateTime()
 
-▸ `Static` **formatDateTime**(`date`, `showSeconds?`): `string`
+> `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. |
+• **date**: `Date`
+
+Data a ser convertida.
+
+• **showSeconds**: `boolean`= `false`
+
+define se devemos considerar os segundos.
 
 #### Returns
 
@@ -131,29 +128,23 @@ Converte a data e hora para uma string no formato pt-BR.
 
 - Uma string com as horas no formato DD/MM/YYYY HH:MM ou DD/MM/YYYY HH:MM:SS.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:53
 
-___
+***
 
-### formatRfc3339
+### formatRfc3339()
 
-▸ `Static` **formatRfc3339**(`date`): `string`
+> `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 |
+• **date**: `Date`
+
+Data a ser convertida
 
 #### Returns
 
@@ -162,24 +153,33 @@ Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
 - Data informada no formato RFC3339.
 *
 
-#### Defined in
+#### Example
+
+```ts
+Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
+```
+
+#### Source
 
 src/utils/DateUtils.ts:186
 
-___
+***
 
-### formatTime
+### formatTime()
 
-▸ `Static` **formatTime**(`date`, `showSeconds?`): `string`
+> `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. |
+• **date**: `Date`
+
+Data a ser convertida.
+
+• **showSeconds**: `boolean`= `false`
+
+define se devemos considerar os segundos.
 
 #### Returns
 
@@ -187,23 +187,23 @@ Converte as horas de uma data para uma string pt-BR.
 
 - Uma string com as horas no formato HH:MM ou HH:MM:SS.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:41
 
-___
+***
 
-### getToday
+### getToday()
 
-▸ `Static` **getToday**(`withTime?`): `Date`
+> `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. |
+• **withTime**: `boolean`= `false`
+
+Caso true retorna a data com informações de horário.
 
 #### Returns
 
@@ -211,61 +211,65 @@ Obtém a data atual.
 
 - Data atual sem informação de horário.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:107
 
-___
+***
 
-### pad
+### pad()
 
-▸ `Static` `Private` **pad**(`n`): `string` \| `number`
+> `static` `private` **pad**(`n`): `string` \| `number`
 
 Adiciona uma casa decimal a esquerda de uma unidade.
 
-**`Example`**
+#### Parameters
+
+• **n**: `number`
+
+Número a ser ajustado
+
+#### Returns
+
+`string` \| `number`
+
+- O número informado, com uma casa decimal a esquerda.
+
+#### Examples
 
 ```ts
 Informo: 15     | Obtenho: 15
 ```
 
-**`Example`**
-
 ```ts
 Informo:  2     | Obtenho: "02"
 ```
 
-#### Parameters
+#### Source
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `n` | `number` | Número a ser ajustado |
+src/utils/DateUtils.ts:155
 
-#### Returns
+***
 
-`string` \| `number`
+### strToDate()
 
-- O número informado, com uma casa decimal a esquerda.
+> `static` **strToDate**(`strValue`, `adjustDayLightSavingTime`, `monthYearMode`): `undefined` \| `Date`
 
-#### Defined in
+Converte String para Date.
 
-src/utils/DateUtils.ts:155
+#### Parameters
 
-___
+• **strValue**: `string`
 
-### strToDate
+Texto a ser convertido para data.
 
-▸ `Static` **strToDate**(`strValue`, `adjustDayLightSavingTime?`, `monthYearMode?`): `undefined` \| `Date`
+• **adjustDayLightSavingTime**: `boolean`= `true`
 
-Converte String para Date.
+Se verdadeiro, ativa regra de horário de verão.
 
-#### Parameters
+• **monthYearMode**: `boolean`= `false`
 
-| 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. |
+Quando ativado, retorna o primeiro dia do mês apenas para construir a data.
 
 #### Returns
 
@@ -273,23 +277,23 @@ Converte String para Date.
 
 - Data sem as informações de horário.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:65
 
-___
+***
 
-### timezoneOffset
+### timezoneOffset()
 
-▸ `Static` `Private` **timezoneOffset**(`offset`): `string`
+> `static` `private` **timezoneOffset**(`offset`): `string`
 
 Retorna timezone da data.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `offset` | `number` | Valor do timezone desejado. |
+• **offset**: `number`
+
+Valor do timezone desejado.
 
 #### Returns
 
@@ -297,24 +301,27 @@ Retorna timezone da data.
 
 Timezone da data.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:165
 
-___
+***
 
-### validateDate
+### validateDate()
 
-▸ `Static` **validateDate**(`value`, `hasTime?`): `undefined` \| `Date`
+> `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. |
+• **value**: `Date`
+
+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
 
@@ -322,6 +329,6 @@ Retorna se a data é válida.
 
 - Caso válida, retorna a própria data.
 
-#### Defined in
+#### Source
 
 src/utils/DateUtils.ts:124