import Component from 'ics-js/src/Component.js'

public class | source

Component

Base class for components.

Constructor Summary

Public Constructor
public	constructor Create a new component.

Public Methods
public	addComponent(component: Component): Component Add a component to the component.
public	addProp(name: string, value: *, props: Object, skipTransformer: boolean): Property Add a property to the component.
public	componentNames(): string[] Get a frozen array of the component's components' names.
public	components(): Component[] Get a frozen array of the component's components.
public	propNames(): string[] Get a frozen array of the component's properties' names.
public	props(): Property[] Get a frozen array of the component's properties.
public	reset() Reset the components components and properties to the default empty state.
public	toBase64(): String Get a Base64 encoded string representation of the component.
public	toBlob(): Blob Get a Blob representation of the component.
public	toString(): string Get a string representation of the component.
public	validateRequired(): boolean Validate if all required properties have been added.

Create a new component.

Add a component to the component.

Name	Type	Attribute	Description
component	Component		Configured component to add to the component.

Provided component.

Provided component type is not in the component's list of valid component types.

Add a property to the component.

Name	Type	Attribute	Description
name	string		Name of the property (e.g. DTSTAMP).
value	*	optional	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.