Home Reference Source Test Repository
import Property from 'ics-js/src/Property.js'
public class | source

Property

Direct Subclass:

CATEGORIES, DTSTAMP, EXDATE, GEO, TRANSP, UID, VERSION

Indirect Subclass:

CREATED, DTEND, DTSTART, DUE, LAST_MODIFIED, RDATE

Base class for properties.

Constructor Summary

Public Constructor
public

constructor(value: *, props: Object, skipTransformer: boolean)

Create a new property.

Member Summary

Public Members
public

Determine if the property's value is transformed.

public

value: *

The property's value.

Method Summary

Public Methods
public abstract

Determine if the property's value is transformed. Returning true causes the transformer to be skipped.

public

Get a string representation of the property.

public

Get the property's properties formatted for string output.

public

Get the property's value. The value is transformed if needed.

public abstract

Function that transforms the value.

Public Constructors

public constructor(value: *, props: Object, skipTransformer: boolean) source

Create a new property.

Params:

NameTypeAttributeDescription
value *

Value of the property.

props Object
  • optional
  • default: {}

Object of properties for the property. Object keys and values are directly injected.

skipTransformer boolean
  • optional
  • default: false

Explicitly determine if the property's value is transformed.

Public Members

public skipTransformer: boolean source

Determine if the property's value is transformed.

public value: * source

The property's value.

Public Methods

public abstract shortTransformer(): boolean source

Determine if the property's value is transformed. Returning true causes the transformer to be skipped.

Return:

boolean

Whether the property's value is transformed.

public toString(): string source

Get a string representation of the property.

Return:

string

String representation of the property.

public transformedProps(): string source

Get the property's properties formatted for string output.

Return:

string

The property's properties formatted for string output.

public transformedValue(): * source

Get the property's value. The value is transformed if needed.

Return:

*

The property's value (transformed if needed).

public abstract transformer(): * source

Function that transforms the value.

Return:

*

The property's transformed value.