Added toObject converters

Author: sebastian-lenz

bin/typedoc.js

@@ -496,6 +496,7 @@ module td
             }
 
             this.traverse((child, property) => {
+                if (property == TraverseProperty.TypeLiteral) return;
                 var name = TraverseProperty[property];
                 name = name.substr(0, 1).toLowerCase() + name.substr(1);
                 if (!result[name]) result[name] = [];

src/td/models/Reflection.ts

@@ -1,10 +1,36 @@
 module td
 {
+    /**
+     * Base class of all type definitions.
+     *
+     * Instances of this class are also used to represent the type `void`.
+     */
     export class Type
     {
+        /**
+         * Is this an array type?
+         */
         isArray:boolean;
 
 
+        /**
+         * Return a raw object representation of this type.
+         */
+        toObject():any {
+            var result:any = {};
+            result.type = 'void';
+
+            if (this.isArray) {
+                result.isArray = this.isArray;
+            }
+
+            return result;
+        }
+
+
+        /**
+         * Return a string representation of this type.
+         */
         toString():string {
             return 'void';
         }

src/td/models/Type.ts

@@ -145,12 +145,6 @@ module td
 
 
 
-        /**
-         * Is this reflection representing a container like a module or class?
-        isContainer() {
-            return this.kindOf(TypeScript.PullElementKind.SomeContainer);
-        }
-         */
         getAllSignatures():SignatureReflection[] {
             var result = [];
 
@@ -205,6 +199,39 @@ module td
          */
         toObject():any {
             var result = super.toObject();
+
+            if (this.type) {
+                result.type = this.type.toObject();
+            }
+
+            if (this.defaultValue) {
+                result.defaultValue = this.defaultValue;
+            }
+
+            if (this.overwrites) {
+                result.overwrites = this.overwrites.toObject();
+            }
+
+            if (this.inheritedFrom) {
+                result.inheritedFrom = this.inheritedFrom.toObject();
+            }
+
+            if (this.extendedTypes) {
+                result.extendedTypes = this.extendedTypes.map((t) => t.toObject());
+            }
+
+            if (this.extendedBy) {
+                result.extendedBy = this.extendedBy.map((t) => t.toObject());
+            }
+
+            if (this.implementedTypes) {
+                result.implementedTypes = this.implementedTypes.map((t) => t.toObject());
+            }
+
+            if (this.implementedBy) {
+                result.implementedBy = this.implementedBy.map((t) => t.toObject());
+            }
+
             return result;
         }
 

src/td/models/reflections/DeclarationReflection.ts

@@ -26,6 +26,24 @@ module td
         }
 
 
+        /**
+         * Return a raw object representation of this reflection.
+         */
+        toObject():any {
+            var result = super.toObject();
+
+            if (this.type) {
+                result.type = this.type.toObject();
+            }
+
+            if (this.defaultValue) {
+                result.defaultValue = this.defaultValue;
+            }
+
+            return result;
+        }
+
+
         /**
          * Return a string representation of this reflection.
          */

src/td/models/reflections/ParameterReflection.ts

@@ -51,6 +51,36 @@ module td
         }
 
 
+        /**
+         * Return a raw object representation of this reflection.
+         */
+        toObject():any {
+            var result = super.toObject();
+
+            if (this.parameters && this.parameters.length) {
+                result.parameters = this.parameters.map((n) => n.toObject());
+            }
+
+            if (this.typeParameters && this.typeParameters.length) {
+                result.typeParameters = this.typeParameters.map((n) => n.toObject());
+            }
+
+            if (this.type) {
+                result.type = this.type.toObject();
+            }
+
+            if (this.overwrites) {
+                result.overwrites = this.overwrites.toObject();
+            }
+
+            if (this.inheritedFrom) {
+                result.inheritedFrom = this.inheritedFrom.toObject();
+            }
+
+            return result;
+        }
+
+
         /**
          * Return a string representation of this reflection.
          */

src/td/models/reflections/SignatureReflection.ts

@@ -14,5 +14,19 @@ module td
             super(parent, type.name, ReflectionKind.TypeParameter);
             this.type = type.constraint;
         }
+
+
+        /**
+         * Return a raw object representation of this reflection.
+         */
+        toObject():any {
+            var result = super.toObject();
+
+            if (this.type) {
+                result.type = this.type.toObject();
+            }
+
+            return result;
+        }
     }
 }

src/td/models/reflections/TypeParameterReflection.ts

@@ -1,16 +1,46 @@
 module td
 {
+    /**
+     * Represents an intrinsic type like `string` or `boolean`.
+     *
+     * ~~~
+     * var value:number;
+     * ~~~
+     */
     export class IntrinsicType extends Type
     {
+        /**
+         * The name of the intrinsic type like `string` or `boolean`.
+         */
         name:string;
 
 
+
+        /**
+         * Create a new instance of IntrinsicType.
+         *
+         * @param name  The name of the intrinsic type like `string` or `boolean`.
+         */
         constructor(name:string) {
             super();
             this.name = name;
         }
 
 
+        /**
+         * Return a raw object representation of this type.
+         */
+        toObject():any {
+            var result:any = super.toObject();
+            result.type = 'instrinct';
+            result.name = this.name;
+            return result;
+        }
+
+
+        /**
+         * Return a string representation of this type.
+         */
         toString() {
             return this.name + (this.isArray ? '[]' : '');
         }

src/td/models/types/IntrinsicType.ts

@@ -1,14 +1,46 @@
 module td
 {
+    /**
+     * Represents a type that refers to another reflection like a class, interface or enum.
+     *
+     * ~~~
+     * var value:MyClass;
+     * ~~~
+     */
     export class ReferenceType extends Type
     {
+        /**
+         * The name of the referenced type.
+         *
+         * If the symbol cannot be found cause it's not part of the documentation this
+         * can be used to represent the type.
+         */
         name:string;
 
+        /**
+         * The symbol id of the referenced type as returned from the TypeScript compiler.
+         *
+         * After the all reflections have been generated this is can be used to lookup the
+         * relevant reflection with [[ProjectReflection.symbolMapping]].
+         */
         symbolID:number;
 
+        /**
+         * The resolved reflection.
+         *
+         * The [[TypePlugin]] will try to set this property in the resolving phase.
+         */
         reflection:Reflection;
 
 
+
+        /**
+         * Create a new instance of ReferenceType.
+         *
+         * @param name        The name of the referenced type.
+         * @param symbolID    The symbol id of the referenced type as returned from the TypeScript compiler.
+         * @param reflection  The resolved reflection if already known.
+         */
         constructor(name:string, symbolID:number, reflection?:Reflection) {
             super();
             this.name = name;
@@ -17,6 +49,21 @@ module td
         }
 
 
+        /**
+         * Return a raw object representation of this type.
+         */
+        toObject():any {
+            var result:any = super.toObject();
+            result.type = 'reference';
+            result.name = this.name;
+            result.symbolID = this.symbolID;
+            return result;
+        }
+
+
+        /**
+         * Return a string representation of this type.
+         */
         toString() {
             if (this.reflection) {
                 return this.reflection.name + (this.isArray ? '[]' : '');

src/td/models/types/ReferenceType.ts

@@ -1,17 +1,50 @@
 module td
 {
-
+    /**
+     * Represents a type which has it's own reflection like literal types.
+     *
+     * ~~~
+     * var value:{subValueA;subValueB;subValueC;};
+     * ~~~
+     */
     export class ReflectionType extends Type
     {
+        /**
+         * The reflection of the type.
+         */
         declaration:DeclarationReflection;
 
 
+
+        /**
+         * Create a new instance of ReflectionType.
+         *
+         * @param declaration  The reflection of the type.
+         */
         constructor(declaration:DeclarationReflection) {
             super();
             this.declaration = declaration;
         }
 
 
+        /**
+         * Return a raw object representation of this type.
+         */
+        toObject():any {
+            var result:any = super.toObject();
+            result.type = 'reflection';
+
+            if (this.declaration) {
+                result.declaration = this.declaration.toObject();
+            }
+
+            return result;
+        }
+
+
+        /**
+         * Return a string representation of this type.
+         */
         toString() {
             if (!this.declaration.children && this.declaration.signatures) {
                 return 'function';