What is the process for importing type definitions from a custom module?

Question

What is the process for importing type definitions from a custom module?

I am struggling with a particular issue and finding it difficult to search for a solution. Here is the problem: I have created a TypeScript class that I am exporting:

class MyAPIClass {
  myMethod(one:number) : void;
  secondMethod(text:string) : number;
}
export = MyAPIClass;

Now, I want to use this class in another TypeScript project of mine:

import MyAPIClass = require('../path/MyAPIClass');

let myClass = new MyAPIClass();
myClass.myMethod(1);

Everything works as expected, however, I am not getting the "typings" support. My editor is not recognizing the types from the imported file. Additionally, I am unable to specify the type like this:

let myClass : MyAPIClass = new MyAPIClass();

Is there a way to properly import the typings as well?

typescript typescript-typings

Answer 1

Answer №1

Instead of that, you should try this solution:

class MyAPI {
  myFunction(num:number) : void;
  anotherFunction(str:string) : number;
}

This code snippet exports the class using a named export. To use it in another file, you can simply do:

import {MyAPI} from '../path/MyAPI'

Then, you can create an instance of the class like this:

let apiClass : MyAPI = new MyAPI();

With these changes, everything should work smoothly.

Answer 2

Instead of that, you should try this solution:

class MyAPI {
  myFunction(num:number) : void;
  anotherFunction(str:string) : number;
}

This code snippet exports the class using a named export. To use it in another file, you can simply do:

import {MyAPI} from '../path/MyAPI'

Then, you can create an instance of the class like this:

let apiClass : MyAPI = new MyAPI();

With these changes, everything should work smoothly.

What is the process for importing type definitions from a custom module?

Answer №1

Similar questions

How can a child class access this.props within a function that overrides a parent class's function?

Using Angular 2 along with RxJS to transform an array using Rx Observables

Struggling to successfully deploy a React App to Azure through a Github Actions workflow due to encountering a TypeScript error

Issue with alert not appearing after webpage is refreshed or reloaded on Angular v10

Exploring dynamic data with Highcharts geomaps

The message "Expected a string literal for Angular 7 environment variables" is

Tips for generating cautionary claims in Playwright TypeScript assessments for non-urgent issues?

Utilizing a generic type with the useReducer hook for an output parameter

Building Reusable Functions Using Typescript

Error: Unable to inject UrlHandlingStrategy as no provider was found

Prettier is stripping away TypeScript generic annotations from React class components

Tips for resolving the issue with the 'search input field in the header' across all pages in angular 5 with typescript

Update 2020: The data pathway ".builders['app-shell']" must include the mandatory property 'class'

Issue with Material UI v5: "spacing" property not found on custom theme object

The input 'Element' does not match the expected parameter 'ReactElement<any>' in this context

Exploring TypeScript <T that belongs to any array>

Utilizing object as props in ReactJS with TypeScript

Checkbox: Customize the appearance of the root element

Error: Uncaught Angular8 template parsing issue

The property 'filter' is not recognized on the 'Object' type. An attempt to filter the response was made