• Jump To … +
    awesome-ics.js block.js property-parameter.js property-value.js property.js util.js

  • property.js

  • ¶ 
    Awesome ICS v0.1.0
http://bandraszyk.github.io/awesome-ico/
(c) 2015 Bandro
Awesome ICS may be freely distributed under the MIT license.

    import { splitSafe, mapToJSON, mapToString, isEmptyString } from "./util";
import { PropertyParameter } from "./property-parameter";
import { getValue, PropertyValue, PropertyMultipleValue } from "./property-value";
  • ¶

    Class: Block

    Basic element for building iCalendar objects. It contains type, child blocks and properties.

    export class Property {
  • ¶

    Initializes the instance with default values

        constructor() {
        this.clear();
    }
  • ¶

    Clears the Property by setting default values

        clear() {
        this.parameters = [];
        this.name       = null;
        this.value      = null;
        return this;
    }
  • ¶

    Converts Property to string

        toString() {
        let name = this.name;

        if (this.parameters.length) {
            let parameters = this.parameters.map(mapToString).join(Property.__format.separatorParameter);
            name = `${name}${Property.__format.separatorParameter}${parameters}`;
        }

        let value = `${name}${Property.__format.separatorProperty}${this.value && this.value.toString()}`;
        let returnValue = value.slice(0, Property.__format.lineMaxLength);
        let rest = value.slice(Property.__format.lineMaxLength);

        while(rest.length) {
            rest = ` ${rest}`;
            returnValue = returnValue.concat(Property.__format.newLine + rest.slice(0, Property.__format.lineMaxLength));
            rest = rest.slice(Property.__format.lineMaxLength);
        }

        return returnValue;
    }
  • ¶

    Converts Property to JSON

        toJSON() {
        return {
            name        : this.name,
            parameters  : this.parameters.map(mapToJSON),
            value       : mapToJSON(this.value)
        };
    }
  • ¶

    Converts Block from string, e.g.: ‘PropertyName;PropertyParameter=PropertyParameterValue:PropertyValue’

        convertFromString(string) {
        if (isEmptyString(string)) { return this.clear(); }

        this.name       = splitSafe(string, Property.__format.separatorProperty)[0];
        this.value      = string.slice(this.name.length + 1);

        let parameters = splitSafe(this.name, Property.__format.separatorParameter);

        if (this.name.indexOf(Property.__format.separatorParameter) !== -1) {
            this.name       = parameters[0];
            this.parameters = parameters.slice(1).map(function(paramContent) { return new PropertyParameter().convertFromString(paramContent); });
        }

        this.value = getValue(this.name, this.value, this.parameters);
        return this;
    }
  • ¶

    Sets Property‘s name that must be an instance of string

        setName(name) {
        if (typeof name !== "string" && !(name instanceof String)) {
            throw new Error("[Property] [setName()] The name must be an instance of `String`");
        }

        this.name = name;
        return this;
    }
  • ¶

    Sets Property‘s value that must be an instance of PropertyValue or PropertyMultipleValue

        setValue(value) {
        if (!(value instanceof PropertyValue) && !(value instanceof PropertyMultipleValue)) {
            throw new Error("[Property] [setValue()] The value must be an instance of `PropertyValue` or `PropertyMultipleValue`");
        }

        this.value = value;
        return this;
    }
  • ¶

    Adds parameter to Property. The parameter must be an instance of PropertyParameter

        addParameter(parameter) {
        if (!(parameter instanceof PropertyParameter)) {
            throw new Error("[Property] [addParameter()] The parameter must be an instance of `PropertyParameter`");
        }
        this.parameters.push(parameter);
        return this;
    }
}
  • ¶

    Static members for: Property

    Property.__format = {
    separatorProperty   : ":",
    separatorParameter  : ";",
    lineMaxLength       : 72,
    newLine             : "\n",
    multiLineBegin      : " "
};