Module: design

Source: design.js, line 24

Members

(static) components :Object

Holds the design set for known top-level components

Type:

Object

Properties

Name	Type	Description
`vcard`	module:ICAL~ICAL.design.designSet	vCard VCARD
`vevent`	module:ICAL~ICAL.design.designSet	iCalendar VEVENT
`vtodo`	module:ICAL~ICAL.design.designSet	iCalendar VTODO
`vjournal`	module:ICAL~ICAL.design.designSet	iCalendar VJOURNAL
`valarm`	module:ICAL~ICAL.design.designSet	iCalendar VALARM
`vtimezone`	module:ICAL~ICAL.design.designSet	iCalendar VTIMEZONE
`daylight`	module:ICAL~ICAL.design.designSet	iCalendar DAYLIGHT
`standard`	module:ICAL~ICAL.design.designSet	iCalendar STANDARD

Source: design.js, line 984

Example

let propertyName = 'fn';
let componentDesign = ICAL.design.components.vcard;
let propertyDetails = componentDesign.property[propertyName];
if (propertyDetails.defaultType == 'text') {
  // Yep, sure is...
}

(static) defaultSet :module:ICAL~ICAL.design.designSet

The default set for new properties and components if none is specified.

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 955

(static) defaultType :String

The default type for unknown properties

Type:

String

Source: design.js, line 961

(static) icalendar :module:ICAL~ICAL.design.designSet

The design set for iCalendar (rfc5545/rfc7265) components.

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 1001

(static) strict

Can be set to false to make the parser more lenient.

Source: design.js, line 949

(static) vcard :module:ICAL~ICAL.design.designSet

The design set for vCard (rfc6350/rfc7095) components.

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 1007

(static) vcard3 :module:ICAL~ICAL.design.designSet

The design set for vCard (rfc2425/rfc2426/rfc7095) components.

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 1013

(inner) icalSet :module:ICAL~ICAL.design.designSet

iCalendar design set

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 909

(inner) vcard3Set :module:ICAL~ICAL.design.designSet

vCard 3.0 design set

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 931

(inner) vcardSet :module:ICAL~ICAL.design.designSet

vCard 4.0 design set

Type:

module:ICAL~ICAL.design.designSet

Source: design.js, line 920

Methods

(static) getDesignSet(componentName) → {module:ICAL~ICAL.design.designSet}

Gets the design set for the given component name.

Parameters:

Name	Type	Description
`componentName`	String	The name of the component

Source: design.js, line 1021

Returns:

The design set for the component

Type:: module:ICAL~ICAL.design.designSet

The design data, used by the parser to determine types for properties and other metadata needed to produce correct jCard/jCal data.

Source: design.js, line 945

Members

(static) components :Object

Holds the design set for known top-level components

Type:

Object

Properties

Name	Type	Description
`vcard`	module:ICAL~ICAL.design.designSet	vCard VCARD
`vevent`	module:ICAL~ICAL.design.designSet	iCalendar VEVENT
`vtodo`	module:ICAL~ICAL.design.designSet	iCalendar VTODO
`vjournal`	module:ICAL~ICAL.design.designSet	iCalendar VJOURNAL
`valarm`	module:ICAL~ICAL.design.designSet	iCalendar VALARM
`vtimezone`	module:ICAL~ICAL.design.designSet	iCalendar VTIMEZONE
`daylight`	module:ICAL~ICAL.design.designSet	iCalendar DAYLIGHT
`standard`	module:ICAL~ICAL.design.designSet	iCalendar STANDARD

Source: design.js, line 984

Example

let propertyName = 'fn';
let componentDesign = ICAL.design.components.vcard;
let propertyDetails = componentDesign.property[propertyName];
if (propertyDetails.defaultType == 'text') {
  // Yep, sure is...
}