How to convert a .ts file into TypeScript Definition file?

In TypeScript, .ts files typically contain TypeScript code, including type definitions, classes, and interfaces. If you need to extract type definitions from .ts files and generate TypeScript declaration files (.d.ts files), follow these steps:

Step 1: Prepare Your TypeScript Environment

Ensure that TypeScript is installed in your development environment. You can install TypeScript by running the following command:

bash
npm install -g typescript

Step 2: Write or Optimize Your TypeScript Code

Ensure that the code in your .ts files is clear and modular. Specifically, ensure that all type definitions are exported. For example:

typescript
// example.ts
export interface IExample {
  id: number;
  name: string;
}

export class ExampleClass {
  constructor(public config: IExample) {}
}

Step 3: Use the TypeScript Compiler to Generate .d.ts Files

You can use the TypeScript compiler's command-line tool tsc to generate declaration files. You need to add or modify some configurations in the tsconfig.json file:

json
{
  "compilerOptions": {
    "declaration": true,        // Generate corresponding `.d.ts` files
    "emitDeclarationOnly": true, // Generate only declaration files, not JavaScript files
    "outDir": "./types"          // Output directory for declaration files
  },
  "include": [
    "./src/**/*.ts"              // Specify files to convert
  ],
  "exclude": [
    "node_modules"
  ]
}

Step 4: Run the Compilation Command

Run the TypeScript compilation command in the terminal:

bash
tsc

This command will extract type definitions from your .ts files and generate the corresponding .d.ts files in the specified output directory based on the tsconfig.json file configuration.

Step 5: Verify the Generated .d.ts Files

Check the .d.ts files in the output directory to ensure all exported types are correctly included.

typescript
// types/example.d.ts
export interface IExample {
  id: number;
  name: string;
}

export class ExampleClass {
  constructor(config: IExample);
}

Example: Practical Application

Suppose you are developing a library in a project that includes some public services and models. To allow other projects to utilize the type information of these services and models without runtime dependencies, generate .d.ts files using the above steps and include them in the published npm package. This way, other developers can reference these type definitions in their projects, achieving type-safe programming.