Auto generate index.d.ts, type definitions, from a typescript module

javascript node.js typescript node-modules type-definition
altus picture altus · Jun 5, 2017 · Viewed 15.3k times · Source

If I have a TypeScript module saved as my-function.ts as follows :

export function myFunction (param: number): number { return param }

This will be compiled to JavaScript in whichever way and loose its type definitions. I am then able to create a index.d.ts file which declare this module's definitions, but this seems a bit tedious to redefine/redeclare the definitions.

Are there ways to generate the type definitions automatically from the my-function.ts file to a index.d.ts file?

Answer

Daniel Rosenwasser picture Daniel Rosenwasser · Jun 5, 2017

If you compile with the --declaration flag, TypeScript will automatically generate .d.ts files for you.

This mode will require that you certain types are visible so that they can be described in your .d.ts files.

Related questions

Remove everything after last backslash

var t = "\some\route\here" I need "\some\route" from it. Thank you.

Read More
Typescript import/as vs import/require?

I am using TypeScript with Express/Node.js. For consuming modules, the TypeScript Handbook shows the following syntax: import express = require('express'); But also the typescript.d.ts file shows: import * as express from "express"; I also searched the MSDN …

Read More
No overload matches this call. Type 'string' is not assignable to type 'Signals'

I am using typescript to build a microservice and handling signals as well. The code was working fine till a few days ago but recently it started throwing errors. Couldn't find a fix for the issue. code for handling signals. …

Read More