Generic repository pattern in Typescript - Mini Project: Build & Apply

Generic Repository Pattern in TypeScript

📖 Scenario: You are building a simple data management system for different types of items like books and movies. To keep your code clean and reusable, you want to create a generic repository that can handle basic operations for any type of item.

🎯 Goal: Build a generic repository class in TypeScript that can store, add, and retrieve items of any type. Then use it to manage a collection of books.

📋 What You'll Learn

Create a generic repository class with methods to add and get all items

Use a generic type parameter to allow storing any type of item

Create a Book interface with title and author properties

Create an instance of the repository for books and add some books

Print the list of books stored in the repository

💡 Why This Matters

🌍 Real World

Generic repositories are used in software to manage data storage and retrieval in a consistent way, no matter what kind of data you have.

💼 Career

Understanding generic patterns and TypeScript generics is important for writing scalable and maintainable code in many professional web development jobs.

1

Create the Book interface

Create an interface called Book with two string properties: title and author.

Typescript

// Your code here

Hint

Use the interface keyword to define the shape of a book object.

2

Create the generic Repository class

Create a generic class called Repository with a type parameter T. Inside, create a private array called items to store objects of type T. Initialize it as an empty array.

Typescript

interface Book {
  title: string;
  author: string;
}

// Your code here

Hint

Use class Repository<T> and declare private items: T[] = []; inside it.

3

Add add and getAll methods to Repository

Inside the Repository class, add a method called add that takes a parameter item of type T and adds it to the items array. Also add a method called getAll that returns the array of items.

Typescript

interface Book {
  title: string;
  author: string;
}

class Repository {
  private items: T[] = [];

  // Your code here
}

Hint

Define add(item: T): void to push item into items. Define getAll(): T[] to return items.

4

Use Repository with Book and print all books

Create a variable called bookRepo as a new Repository<Book>. Add two books to bookRepo using the add method with these exact values: { title: "1984", author: "George Orwell" } and { title: "The Hobbit", author: "J.R.R. Tolkien" }. Then print the result of bookRepo.getAll() using console.log.

Typescript

interface Book {
  title: string;
  author: string;
}

class Repository {
  private items: T[] = [];

  add(item: T): void {
    this.items.push(item);
  }

  getAll(): T[] {
    return this.items;
  }
}

// Your code here

Hint

Create bookRepo as new Repository<Book>(). Use add twice with the exact book objects. Print with console.log(bookRepo.getAll()).

Practice

1.

What is the main benefit of using the Generic Repository Pattern in TypeScript?

easy

A. It allows handling multiple data types with one reusable class.

B. It automatically generates UI components.

C. It replaces the need for TypeScript interfaces.

D. It compiles TypeScript code faster.

Solution

1. Step 1: Understand the purpose of the generic repository

   The generic repository pattern is designed to handle data operations for many types using one class or interface.

2. Step 2: Compare options with the pattern's purpose

   Only It allows handling multiple data types with one reusable class. correctly describes this benefit. Options A, B, and C are unrelated to the pattern's main use.

3. Final Answer:

   It allows handling multiple data types with one reusable class. -> Option A

4. Quick Check:

   Generic repository = reusable data handler [OK]

Hint: Generic means reusable for many types [OK]

Common Mistakes:

• Thinking it generates UI components
• Confusing it with TypeScript compilation
• Believing it removes interfaces

2.

Which of the following is the correct way to declare a generic repository interface in TypeScript?

interface IRepository<T> {
  add(item: T): void;
  get(id: number): T | undefined;
}

easy

A. interface IRepository<T> { add(item: T): void; get(id: number): T | undefined; }

B. interface IRepository { add(item: any): void; get(id: number): any; }

C. interface IRepository<T> { add(item: any): void; get(id: number): T; }

D. interface IRepository<T> { add(item: T): T; get(id: string): T | undefined; }

Solution

1. Step 1: Check generic syntax correctness

   interface IRepository<T> { add(item: T): void; get(id: number): T | undefined; } correctly declares a generic interface with type parameter <T> and uses it consistently in method signatures.

2. Step 2: Validate method signatures

   interface IRepository<T> { add(item: T): void; get(id: number): T | undefined; }'s methods use item: T and return T | undefined for get, which is correct. Other options misuse types or parameter types.

3. Final Answer:

   interface IRepository<T> { add(item: T): void; get(id: number): T | undefined; } -> Option A

4. Quick Check:

   Generic interface syntax = interface IRepository<T> { add(item: T): void; get(id: number): T | undefined; } [OK]

Hint: Generic interfaces use <T> and consistent types [OK]

Common Mistakes:

• Using 'any' instead of generic type T
• Mismatching parameter and return types
• Using wrong id parameter type

3.

Given the following generic repository class, what will be the output of the console.log statement?

class Repository<T> {
  private items: T[] = [];
  add(item: T): void {
    this.items.push(item);
  }
  getAll(): T[] {
    return this.items;
  }
}

const repo = new Repository<string>();
repo.add('apple');
repo.add('banana');
console.log(repo.getAll());

medium

A. Error: Type mismatch

B. ['apple']

C. []

D. ['apple', 'banana']

Solution

1. Step 1: Understand the generic repository usage

   The repository is created for strings, so it stores string items in an array.

2. Step 2: Trace the add and getAll methods

   Two strings 'apple' and 'banana' are added, so getAll returns ['apple', 'banana'].

3. Final Answer:

   ['apple', 'banana'] -> Option D

4. Quick Check:

   Added items = ['apple', 'banana'] [OK]

Hint: Add items then getAll returns all added [OK]

Common Mistakes:

• Expecting only one item in output
• Thinking getAll returns empty array
• Confusing type errors

4.

Identify the error in this generic repository implementation:

class Repository<T> {
  private items: T[] = [];
  add(item: T): void {
    this.items.push(item);
  }
  get(id: number): T {
    return this.items[id];
  }
}

const repo = new Repository<number>();
console.log(repo.get(0));

medium

A. The items array should be public, not private.

B. The add method should return the added item.

C. The get method should return T | undefined to handle missing items.

D. The generic type T cannot be used with arrays.

Solution

1. Step 1: Analyze the get method return type

   The get method returns this.items[id], which may be undefined if the index is invalid.

2. Step 2: Check return type compatibility

   Since undefined is possible, the return type should be T | undefined to avoid runtime errors.

3. Final Answer:

   The get method should return T | undefined to handle missing items. -> Option C

4. Quick Check:

   Return type must allow undefined for missing index [OK]

Hint: Allow undefined return for invalid index [OK]

Common Mistakes:

• Ignoring possible undefined return
• Changing add method unnecessarily
• Making items public without reason

5.

You want to create a generic repository that supports updating an item by id. Which method signature correctly fits this requirement?

hard

A. update(item: T): void

B. update(id: number, item: T): boolean

C. update(id: string, item: any): T

D. update(id: number): T | undefined

Solution

1. Step 1: Understand update method needs

   To update an item, you need to specify which item by id and provide the new item data.

2. Step 2: Evaluate method signatures

   update(id: number, item: T): boolean takes an id and a new item of type T, returning boolean to indicate success, which fits the requirement best.

3. Final Answer:

   update(id: number, item: T): boolean -> Option B

4. Quick Check:

   Update needs id and new item, returns success [OK]

Hint: Update needs id and new item, returns success boolean [OK]

Common Mistakes:

• Missing id parameter
• Using wrong parameter types
• Returning wrong type from update