Brazilian Holiday

Simples biblioteca para verificação de feriado a partir de data recebida.

Instalação

``sh
npm install brazilianholiday
``

Métodos

• isHoliday


• createHoliday


• all

$3

> Verifica se data é um feriado

~~~text
//PARAMS

date
- required: true
- type: string
- format: 'DD/MM/YYYY'

uf
- required: false
- type: string
- format: 'XX'

~~~

~~~javascript
const {brazilianHoliday} = require('brazilianholiday');

let date = '01/01/2023';

console.log(brazilianHoliday.isHoliday(date));

/*
{
holiday: true,
description: 'Confraternização Universal',
date: '01/01/2023'
}
*/

date = '20/01/2023';

console.log(brazilianHoliday.isHoliday(date, 'AC'));

/*
{
holiday: true,
description: 'Dia do Católico',
date: '20/01/2023'
}
*/
~~~

$3

>Possibilita a criação de feriados locais/municipais.

- Os feriados não são armazenados em bancos e cada requisição implica no reset daqueles já criados.

- Quando existir a necessidade de novos feriados, a requisição createHoliday deve anteceder a consulta do método isHoliday;

- Desde a versão 2.0.1 (versão em que a função foi disponibilizada), os feriados criados não consideram o estado e a cidade para verificação feita pelo método isHoliday, sendo apenas parâmetros obrigatórios de controle.

- O método retorna um array de objetos que faz referência aos feriados criados.

~~~text
//PARAMS

date
- required: true
- type: string
- format: 'DD/MM/YYYY'

uf
- required: true
- type: string
- format: 'XX'

city
- required: true
- type: string
- format: 'XXXXXX'

description
- required: true
- type: string
- format: 'XXXXXX'

uf
- required: true
- type: string
- format: 'XX'

moveable
- required: false
- type: boolean
- format: true || false
~~~

~~~javascript
const {brazilianHoliday} = require('brazilianholiday');

brazilianHoliday.createHoliday([
{
date: '15/05/2023',
city: 'Passos',
uf: 'MG',
description: 'Aniversário de Passos',
moveable: false
},
{
date: '06/08/2023',
city: 'Passos',
uf: 'MG',
description: 'Dia de Bom Jesus dos Passos',
moveable: false
}
]);

console.log(brazilianHoliday.isHoliday('15/05/2023'))
/*
{
holiday: true,
description: 'Aniversário de Passos',
date: '15/05/2023'
}
*/

~~~

$3

> Retorna json completo de feriados.

~~~javascript
const {brazilianHoliday} = require('brazilianholiday');

console.log(brazilianHoliday.all());
/*
{
moveable: [ Array ],
national: [ Array ],
state: [ Array ],
createdHolidays: [ Array ]
}
*/

~~~

Histórico de Versões

* 2.0.5 [STABLE]
* DOC: readme file
* 2.0.4 [STABLE]
* FIX: tests
* 2.0.3 [STABLE]
* DOC: license file
* 2.0.2 [STABLE]
* FIX: readme documentation
* 2.0.1 [STABLE]
* FEAT: function createHoliday
* 1.0.9 [STABLE]
* FEAT: function all and test
* 1.0.8 [STABLE]
* FEAT: function isHoliday

Como Contribuir

Ajude-nos alimentando o arquivo .json com feriados móveis que variam a cada ano.

~~~json
"moveable": [
{
"year": "2024",
"holidays": [
{
"date": "12/02",
"description": "Carnaval"
},
{
"date": "13/02",
"description": "Carnaval"
},
{
"date": "29/03",
"description": "Paixão de Cristo"
}
]
}
]
~~~

Licença:

MIT © Otávio Silva 2023