TZDate

설명

TZDate는 타임존을 처리하기 위해 만든 커스텀 날짜 클래스이다. 일정 생성 시 일정 시작 일시 또는 끝나는 일시를 TZDate로 지정할 수 있으며, 캘린더 API 중 일시와 관련된 값은 TZDate로 반환된다.

import Calendar, { TZDate } from '@toast-ui/calendar';

const calendar = new Calendar('#container');
calendar.createEvents([
  {
    id: '1',
    calendarId: 'cal1',
    title: 'event',
    start: new TZDate('2022-06-01T10:00:00'), // TZDate
    end: new TZDate('2022-06-01T11:00:00'), // TZDate
  },
]);

console.log(calendar.getDate()); // TZDate
console.log(calendar.getEvent('1', 'cal1').start); // TZDate

인스턴스 생성

타입
- new TZDate(date?: number | string | Date | TZDate)
- new TZDate(year: number, monthIndex: number, day?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number)
파라미터
- date 또는 개별 날짜 및 시각 구성 요소: 날짜와 시각을 나타내는 값

TZDate는 아래 파라미터로 생성할 수 있다.

파라미터 없이: 파라미터가 없으면, 생성 순간의 날짜와 시각을 가지는 TZDate 인스턴스를 생성한다.
UNIX 타임스탬프 값
타임스탬프 문자열
개별 날짜 및 시각 구성 요소
Date 인스턴스
TZDate 인스턴스

TZDate 인스턴스를 제외한 나머지 파라미터는 Date() 생성자 파라미터와 동일하므로, 자세한 내용은 Date() 생성자 파라미터를 참고한다.

import { TZDate } from '@toast-ui/calendar';

const now = new TZDate(); // 파라미터 없음
const date = new TZDate(1654052400000); // UNIX 타임스탬프 값
const date1 = new TZDate('2022-06-01T12:00:00'); // 타임스탬프 문자열
const date2 = new TZDate(2022, 5, 1, 12, 0, 0, 0); // 개별 날짜 및 시각 구성 요소
const now1 = new TZDate(new Date()); // Date 인스턴스
const now2 = new TZDate(new TZDate()); // TZDate 인스턴스

인스턴스 메서드

💡 메서드를 클릭하면 더 자세한 설명과 사용 예시를 볼 수 있다.

메서드	설명
toString	TZDate 인스턴스 일시를 문자열로 반환한다.
toDate	TZDate 인스턴스 일시를 Date 객체로 반환한다.
valueOf	1970년 1월 1일 UTC 이후 TZDate 인스턴스 일시까지 경과 시간(밀리초)을 반환한다.
addFullYear	주어진 숫자 값만큼 연도를 더한다.
addMonth	주어진 숫자 값만큼 월을 더한다.
addDate	주어진 숫자 값만큼 일자를 더한다.
addHours	주어진 숫자 값만큼 시를 더한다.
addMinutes	주어진 숫자 값만큼 분을 더한다.
addSeconds	주어진 숫자 값만큼 초를 더한다.
addMilliseconds	주어진 숫자 값만큼 밀리초를 더한다.
getTime	1970년 1월 1일 UTC 이후 TZDate 인스턴스 일시까지 경과 시간(밀리초)을 반환한다.
getFullYear	TZDate 인스턴스 일시의 연도를 반환한다.
getMonth	TZDate 인스턴스 일시의 월을 반환한다. 월은 0부터 시작하는 값이다. (ex. 3월의 경우 `2`)
getDate	TZDate 인스턴스 일시의 일자를 반환한다.
getDay	TZDate 인스턴스 일시의 요일에 해당하는 숫자 값을 반환한다. 0은 일요일을 나타낸다.
getHours	TZDate 인스턴스 일시의 시를 반환한다.
getMinutes	TZDate 인스턴스 일시의 분을 반환한다.
getSeconds	TZDate 인스턴스 일시의 초를 반환한다.
getMilliseconds	TZDate 인스턴스 일시의 밀리초를 반환한다.
getTimezoneOffset	TZDate 인스턴스의 타임존 오프셋을 반환한다.
setWithRaw	TZDate 인스턴스 일시를 개별 날짜 및 시각 구성 요소로 지정한다.
setTime	TZDate 인스턴스 일시를 1970년 1월 1일 UTC 이후 경과 시간(밀리초)으로 지정한다.
setFullYear	TZDate 인스턴스 일시의 연도를 주어진 숫자 값으로 지정한다.
setMonth	TZDate 인스턴스 일시의 월을 주어진 숫자 값으로 지정한다. 월은 0부터 시작하는 값이다. (ex. 3월의 경우 `2`)
setDate	TZDate 인스턴스 일시의 일자를 주어진 숫자 값으로 지정한다.
setHours	TZDate 인스턴스 일시의 시를 주어진 숫자 값으로 지정한다.
setMinutes	TZDate 인스턴스 일시의 분을 주어진 숫자 값으로 지정한다.
setSeconds	TZDate 인스턴스 일시의 초를 주어진 숫자 값으로 지정한다.
setMilliseconds	TZDate 인스턴스 일시의 밀리초를 주어진 숫자 값으로 지정한다.
tz	주어진 타임존을 따르는 새로운 TZDate 인스턴스를 반환한다.
local	시스템 타임존을 따르는 새로운 TZDate 인스턴스를 반환한다.

toString

타입: toString(): string
리턴: string - TZDate 인스턴스 일시를 나타내는 문자열

TZDate 인스턴스 일시를 문자열로 반환한다. Date 객체의 toString() 함수와 동일한 포맷이다.

Files

tzdate.md

Latest commit

History

tzdate.md

File metadata and controls

TZDate

설명

인스턴스 생성

인스턴스 메서드

toString

toDate

valueOf

addFullYear

addMonth

addDate

addHours

addMinutes

addSeconds

addMilliseconds

getTime

getFullYear

getMonth

getDate

getDay

getHours

getMinutes

getSeconds

getMilliseconds

getTimezoneOffset

setWithRaw

setTime

setFullYear

setMonth

setDate

setHours

setMinutes

setSeconds

setMilliseconds

tz

local