CODEWITHSUNDEEP
typescripttypescript-typings
Max Coplan
Max Coplan

Reputation: 1473

Export all types (and just types) from typescript module

If I want to export all the exported members of a module (including code), I can use

export * from 'module'

If I want to export the type of a class without code I can do

export type {typeName} from 'module'

Now I have a need to export all the types from a module, without code. I would be tempted to do

export type * from 'module'

as that's the intuitive thing, but typescript type exports must be named exports (ts 1383).

So how I can I export everything from a module in such a way that its members cannot be used at runtime?

Workarounds I can think of:

  1. Get over it and use export *. This is an option. But for our use case I don't want users of our library to use these classes, only to use them to annotate their types

  2. Ask pretty-please that everyone who uses our library please use import type {typeName} from 'myLibrary'. I guess this is an option too, but how do I convince users to do this?

tl;dr: How can I emulate global type exports in Typescript?

Upvotes: 27

Views: 20107

Answers (1)

soimon
soimon

Reputation: 2570

As stated in your referenced pull request, wildcard reexporting of types is not yet implemented (and may never). Hence reexporting all types to the root level is currently not possible. The closest you can get is by wrapping the reexported types in their own named collection:

// your-module
import type * as Types from "external-module";
export { Types };

// Usage by the end user
import { Types } from "your-module";
let a:Types.Class;

The drawback of this approach is that the user is not able to import the types independently like import { Class } from "your-module";. The types are exported as type only though, so this would still have no effect on the size of your bundle and one still can't instantiate the exported types.

Upvotes: 13

Related Questions