What is the method for verifying that one type extends another in the TypeScript compiler API?

In the process of building a tool (partly to test its functionality), I am developing a way to condense a set of TypeScript definitions into a clean d.ts file, while ignoring unnecessary helper types used for reshaping data. This approach is proving quite effective so far, except for one frustrating limitation.

Unfortunately, I have encountered an issue where I cannot determine if one type literal extends another - something that should be relatively straightforward.

import ts from 'typescript';

const program = ts.createProgram([], {})
const checker = program.getTypeChecker();

// { result: any }
const node1 = ts.factory.createTypeLiteralNode([
  ts.factory.createPropertySignature([], "result", undefined, ts.factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword))
]);


// { something: any }
const node2 = ts.factory.createTypeLiteralNode([
   ts.factory.createPropertySignature([], "something", undefined, ts.factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword))
 ]);

checker.isTypeAssignableTo(
  checker.getTypeAtLocation(node1),
  checker.getTypeAtLocation(node2)
)

I have attempted various approaches to solve this problem, such as omitting getTypeAtLocation. The method isTypeAssignableTo successfully compares false/true or string/number, but not literals in this context.

It is possible that I am missing something obvious here, either because the solution is simple or incredibly complex and perhaps not worth pursuing further.

Answer №1

The process flow of the TypeScript compiler involves parsing, checking, and then emitting code. When setting up the TypeChecker, it connects nodes in the program with symbols. It is crucial to note that the proper sequence should be obtaining the type checker after parsing the source files in the program (without any errors) using

ts.getPreEmitDiagnostics(program)
. Attempting to create a node before getting the type checker may lead to unreliable results as the nodes lack parent connections and symbol bindings from the program associated with that TypeChecker.

To ensure accurate results, start by parsing the source files in the program, followed by obtaining the type checker. Once this is done, you can access the nodes from the parsed source files recognized by the type checker through the program and use

checker.isTypeAssignableTo(typeA, typeB)
confidently.

Similar questions

If you have not found the answer to your question or you are interested in this topic, then look at other similar questions below or use the search

Deciding when to utilize an interface, when to avoid it, and when to opt for a constructor in Typescript for the creation of JavaScript arrays

Exploring the concept of JavaScript object arrays in TypeScript In my current project, I am retrieving a JSON array from an observable. It seems that I can define and initialize the array without necessarily specifying an interface or type. let cityList[ ...

What steps can be taken to fix a particular JavaScript/TypeScript type within an IDE during compilation?

Consider the following code snippet: class Test{ /** @type {(e : Event)=> void} */ test; } var test2 = new Test(); test2.test = (e) => {} If you were to use this code in a program like VS Code, you will observe that the variable e in the last l ...

Using Handlebars.js with Angular CLI versions 6 and above: A Step-by-Step Guide

Looking to create a customizable customer letter in either plain text or HTML format that can be edited further by the customer. Considering using Handlebars.js to render an HTML template with mustache tags, using a JSON object for business information. T ...

Implementing recursive functionality in a React component responsible for rendering a dynamic form

Hello to all members of the Stack Overflow community! Presently, I am in the process of creating a dynamic form that adapts based on the object provided, and it seems to handle various scenarios effectively. However, when dealing with a nested objec ...

Include a fresh attribute in the Interface

How can I include a boolean property isPhotoSelected: boolean = false; in an API interface that I cannot modify? The current interface looks like this: export interface LibraryItem { id: string; photoURL: string; thumbnailURL: string; fi ...

Adding Dependencies to a Static Factory in Typescript

I have developed a service in typescript as a Class. Within this class, I have defined a static Factory where dependencies are injected. However, when I compress my application, the dependencies get compressed too, leading to an undefined provider error. ...

Angular CDK Overlay allows for bringing multiple overlays to the front effectively

Currently, I am experiencing an issue with Angular 15 where a click event placed within a mousedown event does not trigger. Interestingly, if the position of the element is not changed using appendChild, both the mousedown and click events work as expected ...

Typeorm stored procedure that returns a JSON response

Whenever I execute the stored procedure defined in a Microsoft SQL database using TypeORM as shown below: const result=await conn.query('exec Spname @0,@1',[inp1val,inp2val]); I receive a response from the database, but it comes with an addition ...

Maintaining the selected option on page refresh with React Remix

I have a dropdown menu with 2 choices (en, no) for switching the language when onChange event occurs. To save the selected language, I am using localStorage. Due to the server-side rendering in Remix, direct access to localStorage is not possible. Therefo ...

How can one pass a generic tuple as an argument and then return a generic that holds the specific types within the tuple?

With typescript 4 now released, I was hoping things would be easier but I still haven't figured out how to achieve this. My goal is to create a function that accepts a tuple containing a specific Generic and returns a Generic containing the values. i ...

Obtaining the host and port information from a mongoose Connection

Currently, I am utilizing mongoose v5.7.1 to connect to MongoDb in NodeJS and I need to retrieve the host and port of the Connection. However, TypeScript is throwing an error stating "Property 'host' does not exist on type 'Connection'. ...

Modifying an element's value according to user input: Step-by-step guide

Within my dropdown menu, there is a single option labeled "Others". Upon selecting this option, a textbox appears allowing me to input custom text. Is it possible to dynamically update the value of the <option value="Others">Others</option>, ...

Trouble configuring a React TypeScript router has arisen

Recently, I have successfully set up multiple routers in TypeScript. However, I am facing challenges in implementing the same in a new project for some unknown reason. import React from 'react'; import Container from './Components/Containers ...

Retrieve contextual information within standard providers

I'm currently using nestjs to create a straightforward HTTP rest API, utilizing typeorm. I have set up 2 Postgres databases and would like the ability to access both, although not necessarily simultaneously. Essentially, I am looking to designate whi ...

Adjust the size of the plane in Three.js to match the entire view

English is not my strong suit, as I am Japanese. I apologize for any confusion. Currently, my focus is on studying Three.js. I aim to position a Plane directly in front of the camera as the background. My goal is to have the Plane background fill the en ...

Suddenly encountered issue when working with TypeScript Interfaces while integrating Quicktype 'allOf'

Our transition from using JSON Type Definition to JSON Schema includes the utilization of Quicktype to convert JSON Schemas into TypeScript Types. While Quicktype has been effective in most cases, it seems to struggle with converting Discriminators and mor ...

Revamp the switch-case statement in JavaScript code

Is there a way to refactor this code in order to prevent repeating dailogObj.image? I would have used a return statement if it wasn't for case 5 where two assignments are required. getDialogData(imageNum): any { const dailogObj = { image: ...

Module '. ' or its corresponding type declarations cannot be located

While working on my project with TypeScript and using Cheerio, I encountered an issue when trying to compile it with TSC. The compiler threw the following exception: error TS2307: Cannot find module '.' or its corresponding type declarations. 2 ...

Modify one specific variable within my comprehensive collection on Firebase Firestore

After clicking the button, I need to update a variable. The variable in question is "bagAmount" and it is stored in my firestore collection. Here is a link to view the Firestore Collection: Firestore Collection Currently, I am able to update one of the va ...

Error: Exceeded Maximum Re-Renders. React has set a limit on the number of renders to avoid infinite loops. Issue found in the Toggle Component of Next.js

I am struggling with setting a component to only display when the user wants to edit the content of an entry, and encountering an error mentioned in the title. To achieve this, I have utilized setState to manage a boolean using toggle and setToggle, then ...