Why declaration files are needed in Typescript - See It in Action

Why declaration files are needed

📖 Scenario: Imagine you are using a JavaScript library in your TypeScript project. You want to use its functions safely with clear information about what inputs they expect and what outputs they give.

🎯 Goal: You will create a simple TypeScript declaration file to describe a JavaScript function, then use it in your TypeScript code to see how declaration files help with type safety and better coding experience.

📋 What You'll Learn

Create a declaration file with a function signature

Create a TypeScript file that uses the declared function

Show how TypeScript checks types using the declaration file

Print the result of calling the function

💡 Why This Matters

🌍 Real World

Many JavaScript libraries do not have built-in TypeScript types. Declaration files help TypeScript understand these libraries so developers can use them safely.

💼 Career

Knowing how to write and use declaration files is important for TypeScript developers working with existing JavaScript code or third-party libraries.

1

Create a declaration file for a JavaScript function

Create a file named mathUtils.d.ts and declare a function called add that takes two number parameters named a and b, and returns a number.

Typescript

// Declare the add function with two number parameters and a number return type
// Your code here

Hint

Use the declare function syntax to describe the function signature without implementation.

2

Create a TypeScript file that uses the declared function

Create a file named app.ts and write code that calls the add function with arguments 5 and 7, and stores the result in a variable called sum.

Typescript

declare function add(a: number, b: number): number;

// Call the add function with 5 and 7 and store the result in sum
// Your code here

Hint

Use const sum = add(5, 7); to call the function and save the result.

3

Add a type check by trying to call the function with wrong types

In app.ts, add a line that calls add with arguments "hello" and 10. This should cause a type error because the first argument is not a number.

Typescript

declare function add(a: number, b: number): number;

const sum = add(5, 7);

// Call add with "hello" and 10 to see a type error
// Your code here

Hint

Try calling add with a string and a number to see how TypeScript warns about wrong types.

4

Print the result of the correct function call

Add a console.log statement to print the value of sum.

Typescript

declare function add(a: number, b: number): number;

const sum = add(5, 7);

const errorExample = add("hello", 10);

// Print the sum variable
// Your code here

Hint

Use console.log(sum); to show the result.

Practice

1. Why do TypeScript projects often use declaration files (.d.ts) when working with JavaScript libraries?

easy

A. To run JavaScript code faster in the browser

B. To convert JavaScript code into TypeScript automatically

C. To provide type information so TypeScript can check code correctness

D. To minify JavaScript files for production

Solution

1. Step 1: Understand the role of declaration files

   Declaration files describe the types and structure of JavaScript code so TypeScript can understand it.

2. Step 2: Identify the purpose in TypeScript projects

   They help TypeScript check for errors and provide better code completion by knowing types.

3. Final Answer:

   To provide type information so TypeScript can check code correctness -> Option C

4. Quick Check:

   Declaration files = type info for error checking [OK]

Hint: Declaration files add types to JS for safer TypeScript code [OK]

Common Mistakes:

• Thinking declaration files convert JS to TS
• Believing declaration files improve runtime speed
• Confusing declaration files with minification tools

2. Which of the following is the correct way to reference a declaration file in a TypeScript project?

easy

A. import './library.d.ts';

B. ///

C. require('library.d.ts');

D.

Solution

1. Step 1: Recall the syntax for referencing declaration files

   TypeScript uses triple-slash directives like /// <reference path="..." /> to include declaration files.

2. Step 2: Compare options to this syntax

   Only /// uses the correct triple-slash reference syntax.

3. Final Answer:

   /// <reference path="library.d.ts" /> -> Option B

4. Quick Check:

   Triple-slash reference = correct declaration file syntax [OK]

Hint: Use triple-slash <reference> for declaration files [OK]

Common Mistakes:

• Using import or require for .d.ts files
• Trying to load declaration files as scripts
• Confusing declaration files with JavaScript modules

3. Given the declaration file mathLib.d.ts with declare function add(a: number, b: number): number;, what will be the output of this TypeScript code?

console.log(add(5, '3'));

medium

A. Type error during compilation

B. 8

C. 53

D. Runtime error

Solution

1. Step 1: Understand the declared function signature

   The declaration says add takes two numbers and returns a number.

2. Step 2: Analyze the call with mismatched argument types

   Calling add(5, '3') passes a string instead of a number, causing a type error at compile time.

3. Final Answer:

   Type error during compilation -> Option A

4. Quick Check:

   Type mismatch in declared function call = compile error [OK]

Hint: Check argument types match declaration to avoid compile errors [OK]

Common Mistakes:

• Assuming implicit string-to-number conversion
• Expecting runtime error instead of compile error
• Thinking output will be string concatenation

4. You have a JavaScript library without TypeScript types. You add a declaration file but still get errors when using it. What is the most likely mistake?

medium

A. The declaration file is missing the declare keyword

B. The TypeScript compiler version is too new

C. The JavaScript library code has syntax errors

D. The declaration file is not included or referenced in the project

Solution

1. Step 1: Check how declaration files are used

   Declaration files must be included or referenced so TypeScript knows about them.

2. Step 2: Identify common cause of errors despite declaration files

   If the file is not referenced or included in tsconfig.json, TypeScript ignores it, causing errors.

3. Final Answer:

   The declaration file is not included or referenced in the project -> Option D

4. Quick Check:

   Missing reference to declaration file = errors persist [OK]

Hint: Always include or reference declaration files in your project [OK]

Common Mistakes:

• Forgetting to add declare keyword (less common)
• Blaming JS code syntax instead of TS config
• Assuming compiler version causes missing types

5. You want to use a JavaScript library coolLib in your TypeScript project, but it has no types. How can declaration files help you safely use coolLib and improve your code?

hard

A. By writing a coolLib.d.ts file describing its functions and types, enabling type checking and autocompletion

B. By converting all coolLib JavaScript files to TypeScript manually

C. By ignoring type errors and using any everywhere

D. By installing a runtime type checker to validate coolLib usage

Solution

1. Step 1: Understand the role of declaration files for external JS libraries

   Declaration files describe the library's API and types without changing its code.

2. Step 2: Explain benefits of writing a declaration file

   This allows TypeScript to check your code using the library and provide autocompletion, catching errors early.

3. Final Answer:

   By writing a coolLib.d.ts file describing its functions and types, enabling type checking and autocompletion -> Option A

4. Quick Check:

   Declaration files = safe use + better coding with JS libs [OK]

Hint: Write declaration files to add types without rewriting JS [OK]

Common Mistakes:

• Thinking you must rewrite JS code to TS
• Ignoring type safety by using any everywhere
• Confusing runtime checks with compile-time types