How to export your modules type when compiling Typescript

Question

I have a module written in typescript. Let's keep it simple:

// src/index.ts
import {AwesomeOptions} from './interfaces/Awesome';

export default class Awesome {
    constructor(options: AwesomeOptions) {
        // cool stuff
    }
}

// src/interfaces/Awesone.d.ts
export interface AwesomeOptions {
    // stuff
}

When I compile this to Javascript, I only get the .js files and no type definition is exported. So if I were to import this in another application that is also in Typescript, I wouldn't have my types.

I don't want to manually maintain a index.d.ts and have "types": "./types/index.d.ts" in my package.json.

Aaron Beall · Accepted Answer · 2018-05-04 02:18:00Z

1

Use the declaration compiler option.

Generates corresponding .d.ts file

answered May 4, 2018 at 2:18

Aaron Beall

52.6k26 gold badges91 silver badges109 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Kousha Over a year ago

What if I want all of it compiled into one index.d.ts? Is that possible?

Aaron Beall Over a year ago

I don't think there is currently, but it's on the roadmap: github.com/Microsoft/TypeScript/issues/4433

Collectives™ on Stack Overflow

How to export your modules type when compiling Typescript

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related