Writing custom declaration files in Typescript - Step-by-Step Execution

Concept Flow - Writing custom declaration files

Identify JS module without types

↓

Create .d.ts file

↓

Write declarations: types, interfaces, functions

↓

Save and include in project

↓

Use types in TypeScript code

↓

Compiler checks types using declarations

↓

End

You find a JavaScript module without types, create a .d.ts file declaring its types, then use those types in your TypeScript code for type checking.

Execution Sample

Typescript

declare module "myLib" {
  export function greet(name: string): string;
  export interface User {
    id: number;
    name: string;
  }
}

This declaration file tells TypeScript about the 'myLib' module's function and interface so you can use them with type safety.

Execution Table

Step	Action	Code Evaluated	Result
1	Create declaration file	declare module "myLib" { ... }	Module 'myLib' declared with types
2	Declare function	export function greet(name: string): string;	Function 'greet' expects a string and returns a string
3	Declare interface	export interface User { id: number; name: string; }	Interface 'User' with id and name properties defined
4	Save file	myLib.d.ts saved	Types available for TypeScript compiler
5	Use in code	import { greet, User } from "myLib";	TypeScript recognizes types from declarations
6	Call function	greet("Alice")	Type checked: argument is string, return is string
7	Create User object	const user: User = { id: 1, name: "Bob" };	Object matches declared interface
8	Exit	No errors	TypeScript compilation succeeds

💡 All declarations are recognized and used for type checking, no errors found

Variable Tracker

Variable	Start	After Step 6	After Step 7	Final
greet	undefined	function greet(name: string): string	function greet(name: string): string	function greet(name: string): string
User	undefined	interface User	interface User	interface User
user	undefined	undefined	{ id: 1, name: "Bob" }	{ id: 1, name: "Bob" }

Key Moments - 3 Insights

Why do we need a separate .d.ts file for a JavaScript module?

Because JavaScript files don't have type information, the .d.ts file tells TypeScript what types exist so it can check your code. See execution_table step 1 and 4.

What happens if the declared types don't match the actual JavaScript implementation?

TypeScript trusts the declaration file, so mismatches can cause runtime errors. Declarations must accurately reflect the real code. See execution_table step 6 and 7 for usage.

Can you declare multiple types inside one module declaration?

Yes, you can declare functions, interfaces, types, and more inside the same module block. See execution_table steps 2 and 3.

Visual Quiz - 3 Questions

Look at the execution_table, what type is the parameter of the 'greet' function at step 2?

A number

B boolean

C string

D any

💡 Hint

Check the 'Code Evaluated' column at step 2 in the execution_table

At which step does the TypeScript compiler recognize the declared types for use in code?

A Step 3

B Step 5

C Step 7

D Step 1

💡 Hint

Look for when the code imports and uses the declarations, see 'Action' column

If you forget to save the .d.ts file, what will happen when you try to use the module in TypeScript?

A TypeScript will show errors about missing types

B TypeScript will find the types anyway

C The code will run without any type checking

D The module will be ignored completely

💡 Hint

Refer to the importance of step 4 'Save file' in the execution_table

Concept Snapshot

Writing custom declaration files (.d.ts):
- Use 'declare module "moduleName" { ... }' to describe a JS module
- Inside, declare functions, interfaces, types with proper signatures
- Save the .d.ts file in your project
- TypeScript uses these declarations for type checking
- Keeps JS modules safe and typed in TS projects

Full Transcript

When you use a JavaScript module without built-in types, you create a custom declaration file with a .d.ts extension. This file uses 'declare module' syntax to tell TypeScript about the module's functions and interfaces. For example, you declare a function 'greet' that takes a string and returns a string, and an interface 'User' with id and name properties. After saving this file, TypeScript can check your code that imports and uses these types, preventing errors. The execution steps show creating the declarations, saving the file, and using the types in code with successful type checking. Key points include the need for accurate declarations and saving the file so TypeScript can find it.