UNPKG

@kokr/date

Version:

Provides utilities for Korean dates. 날짜 관련 유틸리티를 제공합니다. 공휴일, 절기, 그리고 잡절 정보를 확인하고, 영업일 기준 날짜 계산을 지원합니다.

34 lines (33 loc) 1.32 kB
export type RetrieveHolidays = (year: number) => Promise<DateInfo[]>; /** 공휴일의 종류, Holiday 공휴일 */ export declare enum DateKind { /** 공휴일 - (예) 설날, 대통령선거일, 추석 (대체공휴일) .. */ Holiday = 1, /** 기념일 - (예) 스승의 날, 국군의 날 .. */ Anniversary = 2, /** 24절기 - (예) 입춘, 경칩 .. */ SolarTerms = 3, /** 잡절 - (예) 정월대보름, 초복, 중복 .. */ Sundry = 4 } /** 공휴일 상세 정보 */ export interface DateInfo { /** YYYY-MM-DD */ date: string; /** 이름 */ name: string; /** 공휴일 여부 */ holiday: boolean; /** API에서 주는 정보, 해당 기념일에 대한 기타 설명이 포함된 경우가 있음. */ remarks: string | null; /** 공휴일인지, 기념일인지, 24절기인지.. enum 참고*/ kind: DateKind; /** HH:mm 정확한 표준 시간, DateKind.SolarTerms(24절기) 경우 반환 */ time: string | null; /** 태양황경(도), DateKind.SolarTerms(24절기) 경우 반환 */ sunLng: number | null; } export interface GetHolidaysFromHttpOptions { uris?: ((year: number) => string)[]; } export declare function getHolidaysFromHttp(year: number, options?: GetHolidaysFromHttpOptions): Promise<DateInfo[]>;