Class Property

Provides a layer on top of the raw jCal object for manipulating a single property, with its parameters and value.

Alias

ICAL.Property

Hierarchy

Property

Index

Constructors

constructor

new Property(jCal, parent?): Property
Creates a new ICAL.Property instance.

It is important to note that mutations done in the wrapper directly mutate the jCal object used to initialize.

Can also be used to create new properties by passing the name of the property (as a String).
Parameters
- jCal: string | any[]
  
  Raw jCal representation OR the new name of the property
- Optional parent: Component
  
  Parent component
Returns Property
- Defined in property.ts:56

Properties

`Private` _parent

_parent: null | Component

`Private` `Optional` _values

_values?: unknown[]

`Private` `Optional` isDecorated

isDecorated?: boolean

`Private` `Optional` isMultiValue

isMultiValue?: boolean

`Private` `Optional` isStructuredValue

isStructuredValue?: boolean

jCal

jCal: any[]

Accessors

`Private` _designSet

get _designSet(): DesignSet
The design set for this property, e.g. icalendar vs vcard

Returns DesignSet
- Defined in property.ts:107

name

get name(): string
The name of this property, in lowercase.

Returns string
- Defined in property.ts:79

parent

get parent(): null | Component
The parent component for this property.

Returns null | Component
- Defined in property.ts:86
set parent(p): void
Parameters
- p: null | Component
Returns void
- Defined in property.ts:90

type

get type(): string
The value type for this property

Returns string
- Defined in property.ts:72

Methods

`Private` _decorate

_decorate(value): any
Private
Decorate a single value, returning its wrapped object. This is used by the hydrate function to actually wrap the value.
Parameters
- value: any
  
  The value to decorate
Returns any
The decorated value
- Defined in property.ts:172

`Private` _hydrateValue

_hydrateValue(index): any
Private
Hydrate a single value. The act of hydrating means turning the raw jCal value into a potentially wrapped object, for example ICAL.Time.
Parameters
- index: number
  
  The index of the value to hydrate
Returns any
The decorated value.
- Defined in property.ts:142

`Private` _setDecoratedValue

_setDecoratedValue(value, index): void
Private
Sets the value at the given index while also hydrating it. The passed value can either be a decorated or undecorated value.
Parameters
- value: any
  
  The value to set
- index: number
  
  The index to set it at
Returns void
- Defined in property.ts:195

`Private` _undecorate

_undecorate(value): any
Private
Undecorate a single value, returning its raw jCal data.
Parameters
- value: any
  
  The value to undecorate
Returns any
The undecorated value
- Defined in property.ts:183

`Private` _updateType

_updateType(): void
Private
Updates the type metadata from the current jCal type and design set.

Returns void
- Defined in property.ts:116

getDefaultType

getDefaultType(): string
Get the default type based on this property's name.

Returns string
The default type for this property
- Defined in property.ts:273

getFirstParameter

getFirstParameter(name): undefined | string
Gets first parameter on the property.
Parameters
- name: string
  
  Parameter name (lowercase)
Returns undefined | string
Parameter value
- Defined in property.ts:231

getFirstValue

getFirstValue<T>(): T
Finds the first property value.
Type Parameters
- T extends null | string | number | true | Duration | Time | Period | Recur | UtcOffset
Returns T
First property value
- Defined in property.ts:303

getParameter

getParameter<T>(name): undefined | T
Gets a parameter on the property.
Type Parameters
- T = string | any[]
Parameters
- name: string
  
  Parameter name (lowercase)
Returns undefined | T
Parameter value
- Defined in property.ts:217

getValues

getValues(): any[]
Gets all values on the property.

NOTE: this creates an array during each call.

Returns any[]
List of values
- Defined in property.ts:326

removeAllValues

removeAllValues(): void
Removes all values from this property

Returns void
- Defined in property.ts:347

removeParameter

removeParameter(name): void
Removes a parameter
Parameters
- name: string
  
  The parameter name
Returns void
- Defined in property.ts:264

resetType

resetType(type): void
Sets type of property and clears out any existing values of the current type.
Parameters
- type: string
  
  New iCAL type (see design.*.values)
Returns void
- Defined in property.ts:292

setParameter

setParameter(name, value): void
Sets a parameter on the property.
Parameters
- name: string
  
  The parameter name
- value: string | any[]
  
  The parameter value
Returns void
- Defined in property.ts:247

setValue

setValue(value): void
Sets the current value of the property. If this is a multi-value property, all other values will be removed.
Parameters
- value: null | string | Record<string, any>
  
  New property value.
Returns void
- Defined in property.ts:394

setValues

setValues(values): void
Sets the values of the property. Will overwrite the existing values. This can only be used for multi-value properties.
Parameters
- values: any[]
  
  An array of values
Returns void
- Defined in property.ts:360

toICALString

toICALString(): string
The string representation of this component.

Returns string
- Defined in property.ts:418

toJSON

toJSON(): Record<string, any>
Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Returns Record<string, any>
- Defined in property.ts:411

`Static` fromString

fromString(str, designSet): Property
Create an ICAL.Property by parsing the passed iCalendar string.
Parameters
- str: string
  
  The iCalendar string to parse
- designSet: DesignSet
  
  The design data to use for this property
Returns Property
The created iCalendar property
- Defined in property.ts:41

Generated using TypeDoc