swedish holidays
v1.1.2
用于计算任何给定年份的所有瑞典假期日期的库。
$ npm install swedish-holidays
import { getHolidays , getUpcomingHolidays , isHoliday , isPublicHoliday } from 'swedish-holidays' ;
// Get an array of all holidays for the current
const holidays = getHolidays ( ) ;
// Get an array of all holidays for a specific year
const holidays2019 = getHolidays ( 2019 ) ;
// Get an array of all upcoming holidays
const upcoming = getUpcomingHolidays ( ) ;
// Check if today is a holiday
const isItAHolidayToday = isHoliday ( ) ;
// Or if you want to check a specific date
const isThisAHoliday = isHoliday ( new Date ( '2019-12-24' ) ) ;
// Check if today is a public holiday in Sweden (see https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/lag-1989253-om-allmanna-helgdagar_sfs-1989-253)
const isItAPublicHolidayToday = isPublicHoliday ( ) ;
// Or if you want to check a specific date
const isThisAPublicHoliday = isPublicHoliday ( new Date ( '2021-11-01' ) ) ;
结果始终是一个Array
,其中填充了 JSON 格式的假日信息,包括名称和日期。
[
{
name : 'Julafton' ,
date : '2019-12-24T00:00:00.000Z' ,
day : 24 ,
month : 12 ,
year : 2019 ,
isPublicHoliday : false ,
} ,
{
name : 'Juldagen' ,
date : '2019-12-25T00:00:00.000Z' ,
day : 25 ,
month : 12 ,
year : 2019 ,
isPublicHoliday : true ,
} ,
...
]
使用isHoliday
时,如果提供的日期不是假日,则结果为false
,否则为假日 JSON 对象。
使用isPublicHoliday
时,如果提供的日期不是公共假期,则结果为false
。
每个假期都会导出并可以单独使用。 IHolidayOptions
用于将参数传递给构造函数。支持年份和本地化。
为了方便起见,假期也可以使用其瑞典语名称导入。
import { MidsummerEve , Midsommarafton } from 'swedish-holidays' ;
// Both will be equal instances of the same class
const midsummerA = new MidsummerEve ( { year : 2022 } ) ;
const midsummerB = new Midsommarafton ( { year : 2022 } ) ;
如果您希望使用默认语言(瑞典语)以外的语言返回假日名称,请使用language
JSON 对象并在将其传递给getHolidays
函数之前对其进行修改。
const { language } = require ( 'swedish-holidays' ) ;
const translation = { ... language } ;
// This value is 'Julafton' by default.
translation . christmasEve = 'Christmas Eve' ;
const holidays2019 = getHolidays ( 2019 , translation ) ;
// or if you want the current year
// supply a year that is 'falsy' e.g. undefined / null / 0 / false
const holidays = getHolidays ( 0 , translation ) ;
或者使用接口IHolidayNames
import { getHolidays , IHolidayNames } from 'swedish-holidays' ;
const language : IHolidayNames = {
...
christmasEve : 'Christmas Eve' ,
...
}
const holidays2019 = getHolidays ( 2019 , language ) ;
该库只能返回 1582 到 8702 之间年份的有效假期。
如果请求的年份无效,则会抛出错误。