diff options
Diffstat (limited to 'doc/ref/javascript/types.texi')
-rw-r--r-- | doc/ref/javascript/types.texi | 63 |
1 files changed, 60 insertions, 3 deletions
diff --git a/doc/ref/javascript/types.texi b/doc/ref/javascript/types.texi index 73a58550..b9e6dbbf 100644 --- a/doc/ref/javascript/types.texi +++ b/doc/ref/javascript/types.texi @@ -10,12 +10,16 @@ Name of all valid icalendar types. period, utc-offset, cal-address, recur, boolean, @end defvar +@deftp {Data Type} ical_type +The union of all elements in @var{all_types}. +@end deftp + @defvar property_names All known names properties (top level keys) can have. Such as ``calscale'', ``dtstart'', ... @end defvar -@defvar valid_fields +@deftypevar {Map<string, string[]>} valid_fields Which property fields each component can hold. @verbatim @@ -23,9 +27,9 @@ Which property fields each component can hold. ... } @end verbatim -@end defvar +@end deftypevar -@defvar valid_input_types +@deftypevar {Map<string, Array<ical_type | ical_type[]>>} valid_input_types Which types are valid to store under each property. If multiple values are an option for that property, then the list of possibilities will contain a sub-list (see example). @@ -36,4 +40,57 @@ the list of possibilities will contain a sub-list (see example). ... } @end verbatim +@end deftypevar + +@deftp {Data Type} tagname +Alias of (@code{'vevent'} | @code{'string'}). +@end deftp + +@deftp {Data Type} uid +Alias of @code{'string'}. +@end deftp + +@c TODO link to the RFC +@c - RFC 7265 (jCal) + +@deftp {Data Type} JCalProperty +Alias for a record consisting of +@itemize @bullet +@item the name of the type, as a string +@item All parameters of the object, as a @code{Record<string, any}@ + @footnote{Which is simply a regular javascript object, mapping + strings to anything}. +@item An @code{ical_type} value, noting the type of the final field(s) +@item And one or more values of the type specified by the third field. +@end itemize +@end deftp + +@deftp {Data Type} JCal +A record consisting of a @code{tagname}, a list of +@code{JCalProperties}, and a list of other @code{JCal} objects. +@end deftp + +@defvar xcal +The xml namespace name for xcalendar, which is +``urn:ietf:params:xml:ns:icalendar-2.0''. @end defvar + + +@deftp {Interface} ChangeLogEntry +@anchor{ChangeLogEntry} + +@ref{VEventChangelog} + +@deftypecv {Interface Field} ChangeLogEntry {(@code{'calendar'} | @code{'property'})} type +@end deftypecv + +@deftypecv {Interface Field} ChangeLogEntry {string} name +@end deftypecv + +@deftypecv {Interface Field} ChangeLogEntry {string?} from +@end deftypecv + +@deftypecv {Interface Field} ChangeLogEntry {string?} to +@end deftypecv + +@end deftp |