ical-generator 3.5.1 → 3.5.2-develop.2

package/src/category.ts

@@ -0,0 +1,98 @@
+'use strict';
+
+
+import {escape} from './tools';
+
+
+export interface ICalCategoryData {
+    name?: string | null
+}
+
+export interface ICalCategoryInternalData {
+    name: string | null
+}
+
+
+/**
+ * Usually you get an `ICalCategory` object like this:
+ *
+ * ```javascript
+ * import ical from 'ical-generator';
+ * const calendar = ical();
+ * const event = calendar.createEvent();
+ * const category = event.createCategory();
+ * ```
+ *
+ * You can also use the [[`ICalCategory`]] object directly:
+ *
+ * ```javascript
+ * import ical, {ICalCategory} from 'ical-generator';
+ * const category = new ICalCategory();
+ * event.categories([category]);
+ * ```
+ */
+export default class ICalCategory {
+    private readonly data: ICalCategoryInternalData;
+
+    /**
+     * Constructor of [[`ICalCategory`]].
+     * @param data Category Data
+     */
+    constructor(data: ICalCategoryData) {
+        this.data = {
+            name: null
+        };
+
+        data.name !== undefined && this.name(data.name);
+    }
+
+
+    /**
+     * Get the category name
+     * @since 0.3.0
+     */
+    name(): string | null;
+
+    /**
+     * Set the category name
+     * @since 0.3.0
+     */
+    name(name: string | null): this;
+    name(name?: string | null): this | string | null {
+        if (name === undefined) {
+            return this.data.name;
+        }
+
+        this.data.name = name || null;
+        return this;
+    }
+
+
+    /**
+     * Return a shallow copy of the category's options for JSON stringification.
+     * Can be used for persistence.
+     *
+     * @since 0.2.4
+     */
+    toJSON(): ICalCategoryInternalData {
+        return Object.assign({}, this.data);
+    }
+
+
+    /**
+     * Return generated category name as a string.
+     *
+     * ```javascript
+     * console.log(category.toString());
+     * ```
+     */
+    toString(): string {
+
+        // CN / Name
+        if (!this.data.name) {
+            throw new Error('No value for `name` in ICalCategory given!');
+        }
+
+        return escape(this.data.name, false);
+    }
+}