Module augmentation syntax in Typescript

Introduction

Module augmentation lets you add new features to existing modules without changing their original code. It helps you extend or fix modules safely.

You want to add new functions or types to a library module you use.

You need to fix or improve type definitions from a third-party package.

You want to add extra properties to existing interfaces in a module.

You want to customize behavior of a module without forking or copying it.

Syntax

Typescript

declare module "module-name" {
  // add new types, interfaces, or values here
  interface ExistingInterface {
    newProperty: string;
  }
  function newFunction(): void;
}

Use declare module "module-name" to tell TypeScript you want to add to that module.

Only add new things or extend existing ones; do not redefine completely.

Examples

This adds an age property to the existing User interface in the my-library module.

Typescript

declare module "my-library" {
  interface User {
    age: number;
  }
}

This adds an optional userId property to Express's Request interface.

Typescript

declare module "express" {
  interface Request {
    userId?: string;
  }
}

This adds a new function newHelper to the some-package module.

Typescript

declare module "some-package" {
  function newHelper(): void;
}

Sample Program

This program adds a new optional property userRole to Express's Request interface using module augmentation. Then it creates a request object, sets the user role, and prints it.

Typescript

import { Request } from "express";

declare module "express" {
  interface Request {
    userRole?: string;
  }
}

function printUserRole(req: Request) {
  if (req.userRole) {
    console.log(`User role is: ${req.userRole}`);
  } else {
    console.log("User role is not set.");
  }
}

const req = {} as Request;
req.userRole = "admin";
printUserRole(req);

Important Notes

Module augmentation only works if the module is imported or referenced in your code.

Be careful not to overwrite existing types; always extend them.

Use module augmentation to keep your code compatible with library updates.

Summary

Module augmentation lets you add or extend types in existing modules.

Use declare module "module-name" to start augmentation.

It helps customize or fix third-party modules without changing their source.

Practice

1. What is the main purpose of module augmentation in TypeScript?

easy

A. To create a new module from scratch

B. To delete types from a module

C. To add or extend types in an existing module without modifying its original source code

D. To convert JavaScript code into TypeScript

Solution

1. Step 1: Understand module augmentation purpose

   Module augmentation allows adding or extending types in existing modules without changing their original code.

2. Step 2: Compare options

   Only To add or extend types in an existing module without modifying its original source code correctly describes this purpose. Options A, C, and D describe unrelated actions.

3. Final Answer:

   To add or extend types in an existing module without modifying its original source code -> Option C

4. Quick Check:

   Module augmentation = extend existing types [OK]

Hint: Module augmentation means adding types to existing modules [OK]

Common Mistakes:

• Thinking it creates new modules
• Confusing augmentation with deleting types
• Assuming it converts JS to TS

2. Which of the following is the correct syntax to start a module augmentation for a module named "my-library"?

easy

A. module augment "my-library" { /* augmentation here */ }

B. declare module "my-library" { /* augmentation here */ }

C. augment module "my-library" { /* augmentation here */ }

D. module "my-library" augment { /* augmentation here */ }

Solution

1. Step 1: Recall correct syntax for module augmentation

   The correct syntax uses declare module "module-name" { ... } to augment a module.

2. Step 2: Check options

   Only declare module "my-library" { /* augmentation here */ } matches this syntax exactly. Others use invalid keywords or order.

3. Final Answer:

   declare module "my-library" { /* augmentation here */ } -> Option B

4. Quick Check:

   Use declare module "name" for augmentation [OK]

Hint: Start with 'declare module "module-name"' for augmentation [OK]

Common Mistakes:

• Using wrong keywords like 'augment' or 'module augment'
• Incorrect order of keywords
• Omitting 'declare'

3. Given the following code, what will be the output of console.log(myLib.newFunction());?

import * as myLib from "my-library";

declare module "my-library" {
  export function newFunction(): string;
}

myLib.newFunction = () => "Hello from augmentation!";

console.log(myLib.newFunction());

medium

A. "Hello from augmentation!"

B. TypeError: myLib.newFunction is not a function

C. undefined

D. SyntaxError

Solution

1. Step 1: Understand augmentation effect

   The module augmentation adds a new function type declaration to "my-library". Then the function is assigned an implementation.

2. Step 2: Check runtime behavior

   Calling myLib.newFunction() runs the assigned arrow function returning the string "Hello from augmentation!".

3. Final Answer:

   "Hello from augmentation!" -> Option A

4. Quick Check:

   Augmented function runs and returns string [OK]

Hint: Augmented functions can be assigned and called normally [OK]

Common Mistakes:

• Assuming augmentation adds runtime code automatically
• Expecting TypeError because function was not originally present
• Confusing type declaration with implementation

4. Identify the error in this module augmentation code:

declare module "utils" {
  export interface Config {
    timeout: number;
  }
}

declare module "utils" {
  export interface Config {
    retries: number;
  }
}

const config: Config = { timeout: 1000, retries: 3 };

medium

A. No error, code is correct

B. The interface Config is declared twice without merging

C. The module name "utils" is invalid

D. The variable config is missing import from "utils"

Solution

1. Step 1: Check interface merging

   Interfaces with the same name in module augmentation merge correctly, so no error there.

2. Step 2: Check usage of Config

   The variable config uses Config but does not import or reference it properly, causing an error.

3. Final Answer:

   The variable config is missing import from "utils" -> Option D

4. Quick Check:

   Missing import causes error, not interface duplication [OK]

Hint: Always import types before using them outside modules [OK]

Common Mistakes:

• Thinking interface redeclaration causes error
• Ignoring missing imports
• Assuming module name is invalid

5. You want to add a new method logInfo(message: string): void to the existing Logger class from a third-party module "logger-lib" without modifying its source. Which is the correct way to do this using module augmentation?

hard

A. declare module "logger-lib" {
interface Logger {
logInfo(message: string): void;
}
}
Logger.prototype.logInfo = function(message) { console.log(message); };

B. module "logger-lib" {
class Logger {
logInfo(message: string): void {}
}
}

C. declare module "logger-lib" {
class Logger {
logInfo(message: string): void {}
}
}

D. augment module "logger-lib" {
interface Logger {
logInfo(message: string): void;
}
}

Solution

1. Step 1: Use correct module augmentation syntax

   Use declare module "logger-lib" { interface Logger { ... } } to add method signature.

2. Step 2: Add method implementation to prototype

   Assign the method to Logger.prototype to add runtime behavior without modifying original source.

3. Final Answer:

   declare module "logger-lib" { interface Logger { logInfo(message: string): void; } } Logger.prototype.logInfo = function(message) { console.log(message); }; -> Option A

4. Quick Check:

   Declare interface then add method to prototype [OK]

Hint: Declare interface then add method to prototype for augmentation [OK]

Common Mistakes:

• Using 'module' instead of 'declare module'
• Declaring class instead of interface in augmentation
• Forgetting to add method implementation