@stevebartmoss/cronosjs/README.md

Libreria para trabajar con fechas

# CronosJs 1.16.17 (Alfa)

- [Documentacion espanol](#ES)
- [Documentacion ingles](#EN)

## ES

Librería para trabajar con fechas en JavaScript

**Importante**

Las funciones ahora pueden trabajar con diferentes tipos de fechas, por defecto new Date espera que el formato sea **YYYY-MM-DD**, pero se implementó una función para normalizar las fechas por lo cual las funciones que reciben de una fecha también deben recibir el formato de la fecha que se envía, en caso de que el formato no este entre los soportados se hará un acercamiento lo mejor que se pueda para determinar el orden de los datos proporcionados.

Los formatos aceptados son: 
- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"
- "YYYY-DD-MM"

## Funciones actuales

Estas son algunas de las funciones que se tienen por el momento

### getDateNow

Devuelve la fecha actual en diferentes formatos

```js
    getDateNow(formnatDate)
```

### Parametros

**formatDate** 
- El formato en el que se quiere la fecha actual, debe ser un string

**Formatos aceptados**
- ISO
- EUR
- USA
- SQL

### getDiference

Toma dos fechas y retorna la diferencia entre dos fechas. El orden de la operación es secondDate - firsDate

```js
    getDiference(firsDate,secondDate,firstFormat,secondFormat)
```

### Parametros

**firsDate**
- La pimer fecha que se tomara para la operacion

**secondDate**

- La segunda fecha que se tomara para la operacion

**firstFormat**

- Formato de la primera fecha

**secondFormat**

- Formato de la segunda fecha

Si solo se envía el primer formato de fecha, se toma como que las fechas comparten formato

### Retorno

Se regresa la diferencia en dias

### addDays 

Toma una fecha y un número de días; a la fecha le suma el número de días

```js
    addDays(date,format,days)
```

### Parametros

**date** 
- Fecha a la cual se sumaran dias

**days**
- Numero de dias que se sumaran a la fecha

**format**

- Es el formato en el que se manda la fecha

### Retorno

La fecha con la suma de los dias

### getDayReference

Toma una fecha y un lenguaje y devuelve el nombre del dia que representa la semana

```js
    getDayReference(date,format,language)
```

### Parametros

**date**
- Fecha dela cual se obtendra a referencia del dia

**language**
- El lenguaje en el que se quiere obtener la referencia del dia

**Formatos de lenguaje**

- en
- es

**format**

- Es el formato en el que se manda la fecha

### Retorno 

La referencia del dia que esta en la fecha proporcionada

### isValidDate

Toma una fecha y valida que sea una fecha correcta

```js
    isValidDate(date,format)
```

### Parametros

**date**
- Fecha que sera validada

**format**
- Formato en el que esta la fecha, si el formato se omite, se hara a mejor aproximancion posible

**Formatos Esperados**

- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"

### Retorno

true si la fecha es valida de lo contrario false

### getFirstDayOfMonth 

recibe una fecha y devuelve el primer dia del mes de esa fecha

```js
    getFirstDayOfMonth(date,format)
```
### Parametros

**date**
- Fecha a partir de la cual se regresa el primer dia del mes

recibe una fecha y devuelve el primer dia del mes de esa fecha

**format**

- Es el formato en el que se manda la fecha

### Retorno

Primer dia del mes de la fecha que se envia

### getLastDayOfMonth

recibe una fecha y devuelve el ultimo dia del mes de esa fecha

```js
    getLastDayOfMonth(date,format)
```

### Parametros

**date** 

- Fecha a partir de la cual se regresa el ultimo dia del mes

**format**

- Es el formato en el que se manda la fecha

### Retorno

Ultimo dia del mes de la fecha que se envia

### calculateAge

recibe una fecha de nacimiento y devuelve la edad que corresponde a esa fecha

```js
    calculateAge(birthDate,format)
```

### Parametros

**birthDate**

- Fecha de nacimiento para calcular la edad

**format**

- Es el formato en el que se manda la fecha

### Retorno

La edad que corresponde a la fecha de nacimiento

### formatDate

recibe una fecha y el formato deseado, devuelve la fecha con el formato que se indico

```js
    formatDate(date,format,formatFinal)
```
### Parametros

**date**

- Fecha que se desea formatear

**format**

- Es el formato en el que se manda la fecha

**formatFinal**

- Formato en el que se quiere la fecha final

### Retorno

La fecha con el nuevo formato

### addMonths 

recibe una fecha y un numero de meses, devuelve la fecha con la suma de los meses que se pasaron

```js
    addMonths(date,format,months)
```

### Parametros

**date**
- Fecha a la cual se le sumaran los meses

**format**

- Es el formato en el que se manda la fecha

**months**
- Numero de meses que se desean sumar a la fecha

### Retorno

La fecha con la suma de los meses especificados

### getUnitDiference

recibe dos fechas y una unidad, devuelve la diferencia entre las dos fechas en la unidad que se envia, el orden de la operacion es endDate - startDate

```js
    getUnitDiference(startDate,endDate,unit,startFormat,endFormat)
```

### Parametros

**startDate** 
- Primera fecha que se tomara para la operacion

**endDate** 
- Segunda fecha que se tomara para la operacion

**unit** 
- Tipo de unidad en la que se quiere la diferencia entre las fechas

**startFormat**

- Formato en el que se manda la primer fecha

**endFormat**

- Formato en el que se manda la segunda fecha, se se omite se toma que las fechas comparten el formato

Las unidades aceptadas son 
- days
- hours
- minutes
- seconds

### Retorno

La diferencia entre las fechas en la unidad que se en envia

### isLeapyear

recibe un anio numerico y retorna true si el anio es biciesto o de lo cotrario retorna false

```js
    isLeapyear(year)
```

### Parametros

**year**
- Anio que se desa comprovar si es biciesto

### Retorno

true si es biciesto o false si no lo es

### toTimestamp

recibe una fecha y una unidad de tiempo, la pasa al formato de la unidas que toma como argumento

```js
    toTimestamp(date,format,unit)
```

### Parametros 

**date**

- Fecha que se quiere pasar a un formato de timestamp

**format**

- Es el formato en el que se manda la fecha

**unit** 

- Unidad a la que se desea pasar la fecha

Las unidades disponibles son 

- seconds
- miliseconds

### Retorno 

Los segundos o mili segundos que corresponden a la fecha envida

### compareDates

recibe dos fechas y las compara el orden de comparacion es date1 < date2

```js
    compareDates(date1,date2,formatOne,formatTwo)
```

### Parametros 

**date1**

- Primer fecha a comparar

**date2** 

- Segunda fecha a comparar

**formatOne**

- Formato en el que se envia la primer fecha

**formatTwo**

- Formato en el que se envia la segunda fecha, si se omite se toma como que las fechas comparten el formato

### Retorno 

si la primer fecha es mayor que la segunda retorna 1, de lo contrario retorna -1 y si las fechas son 
iguales retorna 0

### getMonthName 

recibe una fecha y un lenguaje, retorna el nombre del mes que corresponde a la fecha que se pasa como parametro

```js
    getMonthName(date,format,language)
```

### Parametros

**date**

- Fecha de la cual se quiere obtener el nombre del mes

**format**

- Es el formato en el que se manda la fecha

**language**

- Idioma en el que se quiere el nombre del mes

### Retorno 

Nombre del mes que corresponde a la fecha que se manda como parametro

### isDateInRange

Comprueba si una fecha esta dentro de un rango, el orden de comparacion es startDate <= date <= endDate

```js
    isDateInRange(date,startDate,endDate,dateFormat,startFormat,endFormat)
```

### Parametros

**date**

- Fecha que se quiere comprobar si esta dentro del rango

**startDate**

- Fecha inferior del rango

**endDate**

- Fecha superior del rango

**dateFormat**

- Formato de la fecha que se quiere comprobar dentro del rango de fechas 

**startFormat**

- Formato de la fecha que se toma como inicio del rango

**endFormat**

- Formato de la fecha que se toma como fin del rango

### Retorno

Retorna true si la fecha entra dentro del rango o flase si no esta dentro del rango

### getWeekRange

Obtener el inicio y el fin de seana de una fecha

```js
    getWeekRange(date)
```

### Paramnetros

**date**

- Fecha de la cual se quiere obtener el inicio y fin de de la semana

**format**

- Es el formato en el que se manda la fecha

### Retorno 

Regresa el inicio y fin de semana de la fecha enviada, se toma que la semana inicia en domingo, por lo que buscara el domingo y el sabado a parti de la fecha que se envia

### timestampToDate 

recibe un timestamp y una unidad, devuelve una fecha tomando el timestamp y transformandola a la unidad que se paso

```js
    timestampToDate(timestamp, unit)
```

### Parametros

**timestamp**

- Marca de tiempo que se desea transformar a una fecha

**unit**

- Unidad de tiempo en la que esta la marca de tiempo

Las unidades disponibles son 

- seconds
- miliseconds

### Retorno

Regresa una fecha a partir de la marca de tiempo

### normalizeDate

Esta funcion es para el uso interno de la liberia, pero puede ser utilizada recibe una fecha y la normaliza al estandar de las fechas javascript YYYY-MM-DD

```js
    normalizeDate(date,format)
```

### Parametros

**date**

- Fecha que se quiere normalizar al formato que usa en javascript

**format**

- Formato en el que se envia la fecha que se quiere normalizar, si el formato se omite se trata de hacer la mejor aproximacion a los valores de las fechas

Los formatos aceptados son: 
- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"

## EN

Library to work with dates in JavaScript

**Important**

Functions can now work with different types of dates, by default new Date expects the format to be **YYYYYY-MM-DD**, but a function was implemented to normalize dates so functions that receive from a date must also receive the format of the date being sent, in case the format is not among the supported ones a best-effort approach will be made to determine the order of the data provided.

Accepted formats are:

Los formatos aceptados son: 
- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"

## Current functions

These are some of the functions available at the moment

### getDateNow

Returns the current date in different formats

```js
    getDateNow(formnatDate)
```

### Parameters

**formatDate** 
- The format in which you want the current date, must be a string

**Accepted formats**
- ISO
- EUR
- USA
- SQL

### getDiference

It takes two dates and returns the difference between two dates. The order of the operation is secondDate - firsDate

```js
    getDiference(firsDate,secondDate,firstFormat,secondFormat)
```

### Parameters

**firsDate**
- First date to be taken for the operation

**secondDate**

- The second date to be taken for operation

**firstFormat**

- Format of the first date

**secondFormat**

- Format of the second date

If only the first date format is sent, it is assumed that the dates share the same format.

### Return

The difference is returned in days

### addDays 

Take a date and a number of days; add the number of days to the date.

```js
    addDays(date,format,days)
```

### Parameters

**date** 
- Date to which days will be added

**days**
- Number of days to be added to date

**format**

- It is the format in which the date is sent.

### Return

The date with the sum of the days

### getDayReference

Takes a date and a language and returns the name of the day that represents the week.

```js
    getDayReference(date,format,language)
```

### Parameters

**date**
- Date from which the day's reference will be obtained

**language**
- The language in which you want to obtain the reference of the day.

**Language formats**

- en
- es

**format**

- It is the format in which the date is sent.

### Return 

The day reference is in the date provided.

### isValidDate

Take a date and validate that it is a correct date.

```js
    isValidDate(date,format)
```

### Parameters

**date**
- Date to be validated

**format**
- Format in which the date is in, if the format is omitted, it will be done to the best possible approximation.

**Expected Formats**

- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"

### Return

true if date is valid otherwise false

### getFirstDayOfMonth 

receives a date and returns on the first day of the month of that date

```js
    getFirstDayOfMonth(date,format)
```
### Parameters

**date**
- Date from which the first day of the month is returned

**format**

- It is the format in which the date is sent.

### Return

First day of the month of the date being sent

### getLastDayOfMonth

receives a date and returns the last day of the month of that date

```js
    getLastDayOfMonth(date,format)
```

### Parameters

**date** 

- Date from which the last day of the month is to be returned

**format**

- It is the format in which the date is sent.

### Return

Last day of the month of the date being shipped

### calculateAge

receives a date of birth and returns the age corresponding to that date

```js
    calculateAge(birthDate,format)
```

### Parameters

**birthDate**

- Date of birth to calculate age

**format**

- It is the format in which the date is sent.

### Return

The age corresponding to the date of birth

### formatDate

receives a date and the desired format, returns the date with the format that was specified

```js
    calculateAge(date,format,formatFinal)
```
### Parameters

**date**

- Date to be formatted

**format**

- It is the format in which the date is sent.

**formatFinal**

- Format in which you want the end date

### Return

The date with the new format

### addMonths 

receives a date and a number of months, returns the date with the sum of the months that have elapsed

```js
    addMonths(date,format,months)
```

### Parameters

**date**
- Date to which the following months will be added

**format**

- It is the format in which the date is sent.

**months**
- Number of months you wish to add to date

### Return

The date with the sum of the specified months

### getUnitDiference

receives two dates and one unit, returns the difference between the two dates in the unit to be sent, the order of the operation is endDate - startDate

```js
    getUnitDiference(startDate,endDate,unit,startFormat,endFormat)
```

### Parameters

**startDate** 
- First date to be taken for the operation

**endDate** 
- Second date to be taken for the operation

**unit** 
- Type of unit in which the difference between dates is wanted

**startFormat**

- Format in which the first date is submitted

**endFormat**

- Format in which the second date is sent, if omitted, it is assumed that the dates share the same format.

Accepted units are
- days
- hours
- minutes
- seconds

### Return

The difference between the dates on the unit to be shipped

### isLeapyear

receives a numeric year and returns true if the year is a leap year or otherwise returns false

```js
    isLeapyear(year)
```

### Parameters

**year**
- Year to be checked for leap year

### Return

true if leap or false if not leap

### toTimestamp

receives a date and a unit of time, passes it to the format of the unit it takes as argument

```js
    toTimestamp(date,format,unit)
```

### Parameters 

**date**

- Date to be converted to a timestamp format

**format**

- It is the format in which the date is sent.

**unit** 

- Unit to which you want to move the date

The available units are

- seconds
- miliseconds

### Return 

The seconds or milliseconds corresponding to the date sent

### compareDates

receives two dates and compares them the order of comparison is date1 < date2

```js
    compareDates(date1,date2,formatOne,formatTwo)
```

### Parameters 

**date1**

- First date to compare

**date2** 

- Second date to compare

**formatOne**

- Format in which the first date is sent

**formatTwo**

- Format in which the second date is sent, if omitted it is assumed that the dates share the format.

### Return 

if the first date is greater than the second returns 1, otherwise returns -1 and if the dates are equal returns 0 
equal returns 0

### getMonthName 

receives a date and a language, returns the name of the month that corresponds to the date passed as parameter

```js
    getMonthName(date,format,language)
```

### Parameters

**date**

- Date from which you want to obtain the month name

**format**

- It is the format in which the date is sent.

**language**

- Language in which the name of the month is desired

### Return 

Name of the month that corresponds to the date sent as a parameter

### isDateInRange

Checks if a date falls within a range, the order of comparison is startDate <= date <= endDate

```js
    isDateInRange(date,startDate,endDate,dateFormat,startFormat,endFormat)
```

### Parameters

**date**

- Date to be checked if it is within range

**startDate**

- Lower date of range

**endDate**

- Top of range date

**dateFormat**

- Format of the date to be checked within the date range 

**startFormat**

- Format of the date to be taken as the start of the range

**endFormat**

- Format of the date to be taken as end of range

### Return

Returns true if the date falls within the range, or flase if it does not fall within the range.

### getWeekRange

Get the start and end of week of a date

```js
    getWeekRange(date)
```

### Parameters

**date**

- Date from which the start and end of the week are to be obtained

**format**

- It is the format in which the date is sent.

### Return 

Returns the beginning and end of the week of the date sent, it is assumed that the week starts on Sunday, so it will look for Sunday and Saturday from the date sent.

### timestampToDate 

receives a timestamp and a unit, returns a date by taking the timestamp and transforming it to the unit that was passed

```js
    timestampToDate(timestamp, unit)
```

### Parameters

**timestamp**

- Time stamp to be converted to a date

**unit**

- Unit of time in which the timestamp is located

The available units are 

- seconds
- miliseconds

### Return

Return a date from the timestamp

### normalizeDate

This function is for internal use of the library, but it can be used to receive a date and normalize it to the javascript date standard YYYYY-MM-DD.

```js
    normalizeDate(date,format)
```

### Parametros

**date**

- Date you want to normalize to the format you use in javascript

**format**

- Format in which the date to be normalized is sent, if the format is omitted it is to make the best approximation to the date values. 

Accepted formats are: 
- "DD/MM/YYYY" 
- "MM/DD/YYYY" 
- "YYYY/MM/DD" 
- "DD-MM-YYYY" 
- "MM-DD-YYYY" 
- "YYYY-MM-DD"

### Return

Returns the date in the format YYYYY-MM-DD