Description
@nolock/ezdate is a date module designed for brazilian, it validates business days based on national holidays.
Installation
$ npm install @nolock/ezdate --save
$ yarn add @nolock/ezdate
Using ezdate
Our current server location is "America/Sao_Paulo"
isBusinessDay
isBusinessDay(date: string | Date, hour: number, minute: number)
Parameters
date
Opcional, default: new Date()
hour
Opcional, default: 17
minute
Opcional, default: 0
Example
Example Date = '2021-07-19 16:30:00'
import {isBusinessDay} from '@nolock/ezdate'
console.log(isBusinessDay());
console.log(isBusinessDay('2021-12-25'));
console.log(isBusinessDay(new Date(), 19, 30));
console.log(isBusinessDay(new Date(), 15, 30));
getBusinessDay
getBusinessDay(date: string | Date)
Parameters
date
Opcional, default: new Date()
import {getBusinessDay} from '@nolock/ezdate'
console.log(getBusinessDay());
console.log(getBusinessDay('2021-12-25'));
getNextBusinessDay
getNextBusinessDay(date: string | Date, days: number)
Parameters
date
Opcional, default: new Date()
days
Opcional, default: 1
import {getNextBusinessDay} from '@nolock/ezdate'
console.log(getNextBusinessDay());
console.log(getNextBusinessDay(new Date(), 3));
console.log(getNextBusinessDay(new Date(), 5));
getDate
getDate(date: string | Date)
Parameters
date
Required
import {getDate} from '@nolock/ezdate'
console.log(getDate('2021-07-19'));
getYear
getYear(date: string | Date)
Parameters
date
Opcional, default: new Date()
import {getYear} from '@nolock/ezdate'
console.log(getYear('2021-07-19'));
formatDate
formatDate(date: string | Date, type: TypeDate)
Parameters
date
Required
type
Required
enum TypeDate {
BR,
DB
}
import {formatDate, TypeDate} from '@nolock/ezdate'
console.log(formatDate('2021-07-19', TypeDate.BR));
console.log(formatDate('2021-07-19', 'BR'));
getNationalHolidays
getNationalHolidays(year: number)
Parameters
year
Optional, default: current year
import {getNationalHolidays} from '@nolock/ezdate'
console.log(getNationalHolidays(2021);
isHoliday
isHoliday(date: string | Date)
Parameters
Example Date = '2021-07-19'
date
Optional, default: new Date()
import {isHoliday} from '@nolock/ezdate'
console.log(isHoliday());
console.log(isHoliday('2021-01-01'));
License
@nolock/ezdate is MIT licensed.