TZDate

Description

TZDate is a custom date class created to handle timezones. When creating an event, the event start date or end date can be specified with TZDate, and the date and time-related values in the calendar API are returned as 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

Creating Instance

Type
- new TZDate(date?: number | string | Date | TZDate)
- new TZDate(year: number, monthIndex: number, day?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number)
Parameters
- date or individual date and time components: values representing the date and time

TZDate can be created with the following parameters.

Without parameters: Without parameters, a TZDate instance with the date and time of creation is created.
UNIX timestamp value
Timestamp string
Individual date and time components
Date instance
TZDate instance

Except for the TZDate instance, the rest of the parameters are the same as the Date() constructor parameters, so refer to Date() constructor parameters for details.

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

const now = new TZDate(); // no parameters
const date = new TZDate(1654052400000); // UNIX timestamp value
const date1 = new TZDate('2022-06-01T12:00:00'); // timestamp string
const date2 = new TZDate(2022, 5, 1, 12, 0, 0, 0); // individual date and time components const now1 = new TZDate(new Date()); // Date instance
const now2 = new TZDate(new TZDate()); // TZDate instance

Instance methods

💡 Click on a method to see more detailed explanations and usage examples.

Method	Description
toString	Returns the date and time of the TZDate instance as a string.
toDate	Returns the date and time of the TZDate instance as a Date object.
valueOf	Returns the elapsed time (in milliseconds) from January 1, 1970 UTC to the date and time of the TZDate instance.
addFullYear	Adds years by a given numeric value.
addMonth	Adds months by a given numeric value.
addDate	Adds a number of days to a given numeric value.
addHours	Adds hours by a given numeric value.
addMinutes	Adds minutes to a given numeric value.
addSeconds	Adds seconds to the given numeric value.
addMilliseconds	Adds milliseconds to a given numeric value.
getTime	Returns the elapsed time (in milliseconds) from January 1, 1970 UTC to the date and time of the TZDate instance.
getFullYear	Returns the year of the TZDate instance date and time.
getMonth	Returns the month of the TZDate instance date and time. Month is a zero-based value. (for example, `2` in case of March)
getDate	Returns the day of the TZDate instance date and time.
getDay	Returns a numeric value corresponding to the day of the week of the TZDate instance date and time. 0 represents Sunday.
getHours	Returns the hours of the TZDate instance date and time.
getMinutes	Returns the minutes of the TZDate instanc date and timee.
getSeconds	Returns the seconds of the TZDate instanc date and timee.
getMilliseconds	Returns the milliseconds of the TZDate instanc date and timee.
getTimezoneOffset	Returns the timezone offset of the TZDate instance in minutes.
setWithRaw	Sets the day and time of the TZDate instance with individual date and time components.
setTime	Sets the TZDate instance date and time in milliseconds since January 1, 1970 UTC.
setFullYear	Sets the year and the date of the TZDate instance as a given numeric value.
setMonth	Sets the month of the TZDate instance date and time as a given numeric value. Month is a zero-based value. (for example, `2` in case of March)
setDate	Sets the date of the TZDate instance date and time as a given numeric value.
setHours	Sets the hours of the TZDate instance date and time as a given numeric value.
setMinutes	Sets the minutes of the TZDate instance date and time as a given numeric value.
setSeconds	Sets the seconds of the TZDate instance date and time as a given numeric value.
setMilliseconds	Sets the milliseconds of the TZDate instance as a given numeric value.
tz	Returns a new TZDate instance following the given timezone.
local	Returns a new TZDate instance following the system timezone.

toString

Type: toString(): string
Returns: string - a string representing the date and time of the TZDate instance

Returns the TZDate instance date and time as a string. It has the same format as the toString() function of the Date object.

Files

tzdate.md

Latest commit

History

tzdate.md

File metadata and controls

TZDate

Description

Creating Instance

Instance methods

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