UNPKG

vobject

Version:

iCalendar VObject Manipulation in NodeJS

github.com/outlook/vobject-js

outlook/vobject-js

64 lines (35 loc) • 2.88 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
## vobject.dateTimeValue(dateTimeString='') [`RFC`](http://tools.ietf.org/html/rfc5545#section-3.3.5) This is a DATE-TIME value type to represent a calendar date and time as a value of a [`property`](./property.md). The object methods closely resembles the [`dateValue`](./dateValue.md) object. - `dateTimeString` is an optional constructor date time string parameter in the format `YYYY-MM-DDTHH:mm:ssZ`. If omitted, the dateTimeValue is defaulted to the current date and time. Usage: ```js var dateTimeValue = vobject.dateTimeValue('2013-08-13T17:33:40-04:00'); dateTimeValue.toICS(); // 20130813T213340Z var dateTimeValue = vobject.dateTimeValue('2013-08-13T17:33:40-04:00'); dateTimeValue.setTZID('America/New_York'); dateTimeValue.toICS(); // 20130813173340 ``` which translates to August 13th, 2013 - 9:33:40pm UTC ----------------------------------------------------------------------------------------- ##### dateTimeValue.type = 'dateTimeValue' Type definition of the value. Useful when used in conjunction with [`properties`](./property.md). ----------------------------------------------------------------------------------------- ##### dateTimeValue.parseDateTime(dateTimeString) - `dateTimeString` to parse. Expects the format `YYYY-MM-DDTHH:mm:ssZ`. Ex: 2013-08-13T17:33:40-04:00 ##### dateTimeValue.toDateTime() - **returns** rendered date time string representation of the DATE-TIME value type with the UTC offset. Ex: `2013-08-13T21:33:40+00:00` ----------------------------------------------------------------------------------------- ##### dateTimeValue.parseTimestamp(timestamp) - `timestamp` to parse defined as seconds since UNIX epoch. Expects an INTEGER ##### dateTimeValue.toTimestamp(); - **returns** string representation of timestamp as seconds since UNIX epoch ----------------------------------------------------------------------------------------- ##### dateTimeValue.setTZID(tzid) - `tzid` to set for the date time value. Expects a TZID string. Ex: `America/New_York`, `Europe/Paris` ##### dateTimeValue.getTZID() - **returns** the tzid set for the date time value. Will only work if a time zone name is explicited defined. Date offsets (-04:00) do not have enough information to derive a time zone. ----------------------------------------------------------------------------------------- ##### dateTimeValue.parseICS(ics, tz = UTC) - `ics` string to parse. Expects the absolute format `YYYYMMDDTHHmmssZ` or floating format `YYYYMMDDTHHmmss` and a time zone. Ex: `20130823T213340Z`, `20130823T173340, America/New_York` ##### dateTimeValue.toICS() - **returns** rendered iCalendar string representation of the DATE-TIME value type. If a time zone is set for the value, this will return a floating representation in the format `YYYYMMDDTHHmmss`. Otherwise it will return a UTC representation in the format `YYYYMMDDTHHmmssZ`