File tree Expand file tree Collapse file tree 1 file changed +4
-6
lines changed Expand file tree Collapse file tree 1 file changed +4
-6
lines changed Original file line number Diff line number Diff line change @@ -17,7 +17,7 @@ npm install colombian-holidays
17
17
18
18
## Usage
19
19
20
- The default export is a function to get all the holidays for a given year, returning an array with the holidays for the requested year .
20
+ The default export is a function to get all the holidays for a given year.
21
21
22
22
The ` year ` should be between 1583 and 4099 (see [ Pascua] ( https://github.com/MauricioRobayo/pascua ) package).
23
23
@@ -231,9 +231,7 @@ If the year is omitted, by default the function will return the holidays for the
231
231
232
232
``` js
233
233
const currentYearHolidaysAsStrings = colombianHolidays ();
234
- const currentYearHolidaysAsDates = colombianHolidays ({
235
- valueAsDate: true ,
236
- });
234
+ const currentYearHolidaysAsDates = colombianHolidays ({ valueAsDate: true });
237
235
```
238
236
239
237
## Utils
@@ -242,7 +240,7 @@ The package provides two helper functions which can be imported from `lib/utils`
242
240
243
241
### isHoliday
244
242
245
- Returns true if the given date is a colombian holiday, otherwise returns false.
243
+ Returns ` true ` if the given date is a colombian holiday, otherwise returns ` false ` .
246
244
247
245
``` js
248
246
import { isHoliday } from " colombian-holidays/lib/utils/isHoliday" ;
@@ -258,7 +256,7 @@ if (isHoliday(date)) {
258
256
259
257
### holidaysWithinInterval
260
258
261
- Returns an with the colombian holidays within two dates:
259
+ Returns an array with the colombian holidays within two dates:
262
260
263
261
``` js
264
262
import { holidaysWithinInterval } from " colombian-holidays/lib/utils/holidaysWithinInterval" ;
You can’t perform that action at this time.
0 commit comments