feat: add IsVoid method to Type (#1398)

dsherret · Jun 10, 2023 · f837790 · f837790
1 parent e738204
commit f837790
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/packages/ts-morph/src/compiler/types/Type.ts b/packages/ts-morph/src/compiler/types/Type.ts
@@ -578,6 +578,13 @@ export class Type<TType extends ts.Type = ts.Type> {
   isUndefined() {
     return this._hasTypeFlag(TypeFlags.Undefined);
   }
+
+  /**
+   * Gets if this is the void type.
+   */
+  isVoid() {
+    return this._hasTypeFlag(TypeFlags.Void);
+  }  
 
   /**
    * Gets the type flags.

diff --git a/packages/ts-morph/src/tests/compiler/type/typeTests.ts b/packages/ts-morph/src/tests/compiler/type/typeTests.ts
@@ -57,6 +57,7 @@ let explicitReadonlyArrayType: ReadonlyArray<string>;
 let neverType: never;
 let arrayTypeOfTuples: [string][];
 let undefinedType: undefined;
+let voidType: void;
 let classType: MyClass;
 let functionType: () => string;
 let constructorType: { new(): MyClass; };
@@ -518,6 +519,20 @@ let unknownType: unknown;
       });
     });
 
+    describe(nameof<Type>("isVoid"), () => {
+      function doTest(typeName: string, expected: boolean) {
+        expect(typesByName[typeName].isVoid()).to.equal(expected);
+      }
+
+      it("should be when is", () => {
+        doTest("voidType", true);
+      });
+
+      it("should not be when not", () => {
+        doTest("stringType", false);
+      });
+    });
+
     describe(nameof<Type>("getFlags"), () => {
       it("should get the type flags", () => {
         expect(typesByName["numberType"].getFlags()).to.equal(TypeFlags.Number);