Creating type definitions for TypeScript (ts) involves defining the shape and

Question

Creating type definitions for TypeScript (ts) involves defining the shape and

Having trouble using a library installed in node_modules/ within a typescript app? Here's a quick hack for you. Create a folder named after the module in typings/modules and add an index.d.ts file inside with the following content:

declare module "lib-name" {
  export default class Logger {
    constructor(namespace: string)
  }
}

You should now be able to import the module. However, if you encounter an error like

cannot use 'with' an expression whose type lacks a call or construct signature

when trying to let l = new Lib('namespace');, then there might be a syntax issue that needs addressing.

typescript typescript1.8 typescript-typings

Answer 1

Answer №1

It is recommended to avoid using the class keyword in your typings. Instead, focus on declaring an interface contract.

According to the documentation, a new expression requires a new method in the interface. You can refer to the following link for more information: https://www.typescriptlang.org/docs/handbook/writing-declaration-files.html

You may consider implementing something similar to this:

declare module "lib-name" {
  interface Logger {
    new (namespace: string): Logger
  }

  export var Logger: Logger;
}

Answer 2

It is recommended to avoid using the class keyword in your typings. Instead, focus on declaring an interface contract.

According to the documentation, a new expression requires a new method in the interface. You can refer to the following link for more information: https://www.typescriptlang.org/docs/handbook/writing-declaration-files.html

You may consider implementing something similar to this:

declare module "lib-name" {
  interface Logger {
    new (namespace: string): Logger
  }

  export var Logger: Logger;
}

Creating type definitions for TypeScript (ts) involves defining the shape and

Answer №1

Similar questions

Tips for creating React/MobX components that can be reused

Function parameter constrained to a specific property of a generic type T

Adapting the current codebase to be compatible with Typescript

How can I dispatch multiple actions simultaneously within a single epic using redux-observable?

Discovering how to display the hidden messages section in the absence of any ongoing chats with the help of angular2

Issues arise when attempting to store data into an array with the assistance of FileReader

What could be the reason for Angular to merge the element at index 0 of an array into a subarray instead of doing

Function in Typescript that can return multiple data types

Converting Typescript Object Types to Array Types with Tuple Structures

Having trouble incorporating @types/pdfmake into an Angular project

Error TS2488 in React TypeScript: The data type 'IStateTypes' is required to have a method called '[Symbol.iterator]()' that returns an iterator

Check out the selected values in Ionic 3

Tips for converting NULL% to 0%

The reason behind the error message stating that the argument AwsService at index [1] is available in the TestModule context

Guide on the correct way to develop a Typescript NPM package accompanied by declarations?

Using arrays as props in React with Typescript

Generate a fresh class instance in Typescript by using an existing class instance as the base

A step-by-step guide to showcasing dates in HTML with Angular

Troubleshooting: Why is the Array in Object not populated with values when passed during Angular App instantiation?

Having trouble building my Angular 2 app with Angular-cli beta 14, despite it working perfectly fine with systemjs beforeEach