fix: typeof function (Close #1181)

vega · Mar 26, 2022 · aaed428 · aaed428
1 parent 32e8948
commit aaed428
Show file tree

Hide file tree

Showing 6 changed files with 600 additions and 1 deletion.
diff --git a/factory/formatter.ts b/factory/formatter.ts
@@ -28,6 +28,7 @@ import { UnknownTypeFormatter } from "../src/TypeFormatter/UnknownTypeFormatter"
 import { VoidTypeFormatter } from "../src/TypeFormatter/VoidTypeFormatter";
 import { MutableTypeFormatter } from "../src/MutableTypeFormatter";
 import { NeverTypeFormatter } from "../src/TypeFormatter/NeverTypeFormatter";
+import { FunctionTypeFormatter } from "../src/TypeFormatter/FunctionTypeFormatter";
 
 export type FormatterAugmentor = (
     formatter: MutableTypeFormatter,
@@ -74,7 +75,8 @@ export function createFormatter(config: Config, augmentor?: FormatterAugmentor):
         .addTypeFormatter(new ArrayTypeFormatter(circularReferenceTypeFormatter))
         .addTypeFormatter(new TupleTypeFormatter(circularReferenceTypeFormatter))
         .addTypeFormatter(new UnionTypeFormatter(circularReferenceTypeFormatter))
-        .addTypeFormatter(new IntersectionTypeFormatter(circularReferenceTypeFormatter));
+        .addTypeFormatter(new IntersectionTypeFormatter(circularReferenceTypeFormatter))
+        .addTypeFormatter(new FunctionTypeFormatter());
 
     return circularReferenceTypeFormatter;
 }
diff --git a/src/NodeParser/TypeofNodeParser.ts b/src/NodeParser/TypeofNodeParser.ts
@@ -38,6 +38,10 @@ export class TypeofNodeParser implements SubNodeParser {
             return this.childNodeParser.createType(valueDec, context);
         } else if (ts.isPropertyAssignment(valueDec)) {
             return this.childNodeParser.createType(valueDec.initializer, context);
+        } else if (valueDec.kind === ts.SyntaxKind.FunctionDeclaration) {
+            if ((<ts.FunctionDeclaration>valueDec).type! !== undefined) {
+                return this.childNodeParser.createType(<ts.Node>(<ts.FunctionDeclaration>valueDec).type, context);
+            }
         }
 
         throw new LogicError(`Invalid type query "${valueDec.getFullText()}" (ts.SyntaxKind = ${valueDec.kind})`);

diff --git a/src/TypeFormatter/FunctionTypeFormatter.ts b/src/TypeFormatter/FunctionTypeFormatter.ts
@@ -0,0 +1,29 @@
+import { Definition } from "../Schema/Definition";
+import { SubTypeFormatter } from "../SubTypeFormatter";
+import { BaseType } from "../Type/BaseType";
+import { FunctionType } from "../Type/FunctionType";
+
+export class FunctionTypeFormatter implements SubTypeFormatter {
+    public supportsType(type: FunctionType): boolean {
+        //    console.log("MyCustomFormatter Type", type);
+        return type instanceof FunctionType;
+    }
+
+    public getDefinition(type: FunctionType): Definition {
+        // Return a custom schema for the function property.
+        return {
+            type: "object",
+            properties: {
+                isFunction: {
+                    type: "boolean",
+                    const: true,
+                },
+            },
+        };
+    }
+
+    // If this type does NOT HAVE children, generally all you need is:
+    public getChildren(type: FunctionType): BaseType[] {
+        return [];
+    }
+}
diff --git a/test/valid-data-type.test.ts b/test/valid-data-type.test.ts
@@ -62,6 +62,7 @@ describe("valid-data-type", () => {
     it("type-typeof-class-static-property", assertValidSchema("type-typeof-class-static-property", "MyType"));
     it("type-typeof-enum", assertValidSchema("type-typeof-enum", "MyObject"));
     it("type-typeof-class", assertValidSchema("type-typeof-class", "MyObject"));
+    it("type-typeof-function", assertValidSchema("type-typeof-function", "*"));
     it("type-keys", assertValidSchema("type-typeof-keys", "MyType"));
 
     it("type-indexed-access-tuple-1", assertValidSchema("type-indexed-access-tuple-1", "MyType"));

diff --git a/test/valid-data/type-typeof-function/main.ts b/test/valid-data/type-typeof-function/main.ts
@@ -0,0 +1,3 @@
+import { ConnectionOptions } from "node:tls";
+
+export interface Test extends ConnectionOptions {}