brazilianholiday

Brazilian Holiday

Simples biblioteca que retorna se determinada data é feriado.

Instalação

npm install brazilianholiday --save

Exemplo de Uso

isHoliday(date, uf = null)

Verifica se data é um feriado

//PARÂMETROS

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

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

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

let date = '01/01/2023';

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

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

date = '20/01/2023';

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

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

Histórico de Versões

• 1.0.6
  • FEAT: function isHoliday

Como Contribuir

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

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

License:

MIT © Otávio Silva 2023