feat: Type.prototype.isBigInt and isBigIntLiteral (#1546)

dsherret · Jun 23, 2024 · b3d01c8 · b3d01c8
1 parent 868755d
commit b3d01c8
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/packages/ts-morph/lib/ts-morph.d.ts b/packages/ts-morph/lib/ts-morph.d.ts
@@ -10029,10 +10029,14 @@ export declare class Type<TType extends ts.Type = ts.Type> {
  isString(): boolean;
  /** Gets if this is a number type. */
  isNumber(): boolean;
+ /** Gets if this is a BigInt. */
+ isBigInt(): boolean;
  /** Gets if this is a literal type. */
  isLiteral(): boolean;
  /** Gets if this is a boolean literal type. */
  isBooleanLiteral(): boolean;
+ /** Gets if this is a BigInt literal type. */
+ isBigIntLiteral(): boolean;
  /** Gets if this is an enum literal type. */
  isEnumLiteral(): boolean;
  /** Gets if this is a number literal type. */

diff --git a/packages/ts-morph/src/compiler/types/Type.ts b/packages/ts-morph/src/compiler/types/Type.ts
@@ -443,6 +443,13 @@ export class Type<TType extends ts.Type = ts.Type> {
  return this.#hasTypeFlag(TypeFlags.Number);
  }
 
+ /**
+ * Gets if this is a BigInt.
+ */
+ isBigInt() {
+ return this.#hasTypeFlag(TypeFlags.BigInt);
+ }
+
  /**
  * Gets if this is a literal type.
  */
@@ -459,6 +466,13 @@ export class Type<TType extends ts.Type = ts.Type> {
  return this.#hasTypeFlag(TypeFlags.BooleanLiteral);
  }
 
+ /**
+ * Gets if this is a BigInt literal type.
+ */
+ isBigIntLiteral() {
+ return this.#hasTypeFlag(TypeFlags.BigIntLiteral);
+ }
+
  /**
  * Gets if this is an enum literal type.
  */

diff --git a/packages/ts-morph/src/tests/compiler/type/typeTests.ts b/packages/ts-morph/src/tests/compiler/type/typeTests.ts
@@ -36,6 +36,8 @@ let anyType: any;
 let stringType: string;
 let booleanType: boolean;
 let numberType: number;
+let bigIntType = 5n + 10n;
+const bigIntLiteralType = 5n;
 let booleanLiteralType: true;
 let numberLiteralType: 5;
 let stringLiteralType: 'test';
@@ -156,6 +158,34 @@ let unknownType: unknown;
  });
  });
 
+ describe(nameof<Type>("isBigInt"), () => {
+ function doTest(typeName: string, expected: boolean) {
+ expect(typesByName[typeName].isBigInt()).to.equal(expected);
+ }
+
+ it("should get when it is", () => {
+ doTest("bigIntType", true);
+ });
+
+ it("should get when it's not", () => {
+ doTest("stringType", false);
+ });
+ });
+
+ describe(nameof<Type>("isBigIntLiteral"), () => {
+ function doTest(typeName: string, expected: boolean) {
+ expect(typesByName[typeName].isBigIntLiteral()).to.equal(expected);
+ }
+
+ it("should get when it is", () => {
+ doTest("bigIntLiteralType", true);
+ });
+
+ it("should get when it's not", () => {
+ doTest("stringType", false);
+ });
+ });
+
  describe(nameof<Type>("isBoolean"), () => {
  function doTest(typeName: string, expected: boolean) {
  expect(typesByName[typeName].isBoolean()).to.equal(expected);