DefinitelyTyped and @types packages in Typescript

Introduction

Sometimes TypeScript needs extra information about JavaScript libraries to understand how to use them safely. DefinitelyTyped and @types packages give TypeScript this information.

You want to use a JavaScript library in your TypeScript project and need type information.

You want your code editor to show helpful hints and catch mistakes when using external libraries.

You want to avoid writing type definitions yourself for popular libraries.

You want to share type definitions with others easily.

You want to keep your project organized by installing types separately.

Syntax

Typescript

npm install --save-dev @types/library-name

The @types packages contain type definitions for JavaScript libraries.

They are usually installed as development dependencies because they help during coding but are not needed at runtime.

Examples

This installs type definitions for the popular lodash library.

Typescript

npm install --save-dev @types/lodash

This installs type definitions for the react library, so TypeScript understands React code.

Typescript

npm install --save-dev @types/react

This installs type definitions for Node.js built-in modules, useful when writing server-side TypeScript.

Typescript

npm install --save-dev @types/node

Sample Program

This program uses the lodash library to double numbers in an array. Installing @types/lodash helps TypeScript understand the _.map function and check types.

Typescript

import _ from 'lodash';

const numbers: number[] = [1, 2, 3, 4];
const doubled = _.map(numbers, n => n * 2);
console.log(doubled);

Important Notes

DefinitelyTyped is a big collection of type definitions maintained by the community.

When you install @types/library-name, you get the types from DefinitelyTyped for that library.

If a library already includes its own types, you don't need to install @types separately.

Summary

DefinitelyTyped provides type definitions for many JavaScript libraries.

@types packages let you add these types to your TypeScript projects easily.

Using them helps TypeScript check your code and gives better editor support.

Practice

1. What is the main purpose of the @types packages in TypeScript?

easy

A. To provide type definitions for JavaScript libraries

B. To compile TypeScript code into JavaScript

C. To run JavaScript code in the browser

D. To create new JavaScript libraries

Solution

1. Step 1: Understand the role of @types packages

   @types packages contain type definitions that describe the shape and types of JavaScript libraries for TypeScript.

2. Step 2: Identify the main purpose

   They help TypeScript understand JavaScript libraries by providing type information, enabling better type checking and editor support.

3. Final Answer:

   To provide type definitions for JavaScript libraries -> Option A

4. Quick Check:

   @types = type definitions [OK]

Hint: Remember: @types adds types for JS libs [OK]

Common Mistakes:

• Confusing @types with compilers
• Thinking @types runs code
• Assuming @types creates libraries

2. Which of the following is the correct way to install type definitions for the lodash library using npm?

easy

A. npm install @types/lodash

B. npm install lodash-types

C. npm install types-lodash

D. npm install lodash/@types

Solution

1. Step 1: Recall the naming convention for type packages

   Type definitions from DefinitelyTyped are published under the @types scope, so the package name is @types/library-name.

2. Step 2: Match the correct npm install command

   For lodash, the correct package is @types/lodash, so the command is npm install @types/lodash.

3. Final Answer:

   npm install @types/lodash -> Option A

4. Quick Check:

   Type packages start with @types/ [OK]

Hint: Type packages always start with @types/ [OK]

Common Mistakes:

• Using incorrect package names without @types/
• Mixing up package and type package names
• Trying to install types as normal packages

3. Given the following TypeScript code, what will be the output if @types/lodash is NOT installed?

import _ from 'lodash';

const numbers = [1, 2, 3];
const doubled = _.map(numbers, n => n * 2);
console.log(doubled);

medium

A. [] (empty array)

B. [2, 4, 6]

C. Runtime error: _.map is not a function

D. TypeScript error: Cannot find module 'lodash' or its corresponding type declarations

Solution

1. Step 1: Understand the role of type definitions in TypeScript

   Without @types/lodash, TypeScript cannot find type information for lodash, causing a compile-time error.

2. Step 2: Identify the error message

   The error will say it cannot find the module or its type declarations, preventing compilation.

3. Final Answer:

   TypeScript error: Cannot find module 'lodash' or its corresponding type declarations -> Option D

4. Quick Check:

   No types = compile error [OK]

Hint: No @types means TypeScript can't find types [OK]

Common Mistakes:

• Confusing runtime errors with compile errors
• Expecting code to run without types installed
• Thinking JavaScript errors appear instead

4. You installed @types/express but still get errors about missing types when importing express. What is the most likely cause?

medium

A. You need to restart your TypeScript server or IDE

B. You installed the wrong version of @types/express

C. You forgot to install the express package itself

D. You must import types explicitly using import type

Solution

1. Step 1: Check dependencies

   Type definitions only provide types; the actual library must be installed separately.

2. Step 2: Identify missing library

   If express is not installed, importing it causes errors despite having types.

3. Final Answer:

   You forgot to install the express package itself -> Option C

4. Quick Check:

   Types need actual library installed [OK]

Hint: Always install both library and its @types [OK]

Common Mistakes:

• Assuming types include the library code
• Not restarting IDE after install
• Misusing import type for libraries

5. You want to use a JavaScript library foo-lib in your TypeScript project, but no @types/foo-lib package exists. What is the best way to add type support?

hard

A. Ignore type errors and use any everywhere

B. Write a custom declaration file foo-lib.d.ts with needed types

C. Install @types/foo-lib anyway, it will work

D. Rewrite the library in TypeScript

Solution

1. Step 1: Understand missing type definitions

   If no official @types package exists, you can create your own declaration file to describe the library's types.

2. Step 2: Choose best practice

   Writing a .d.ts file lets TypeScript check your code and improves editor support without rewriting the library.

3. Final Answer:

   Write a custom declaration file foo-lib.d.ts with needed types -> Option B

4. Quick Check:

   Custom .d.ts files add missing types [OK]

Hint: Create .d.ts files for missing types [OK]

Common Mistakes:

• Ignoring types and risking bugs
• Expecting non-existent @types packages
• Thinking rewriting library is easiest