TypeScript-first philosophy in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does the "TypeScript-first philosophy" mean in NestJS?

It means NestJS is designed to use TypeScript as the main language, leveraging its features like types and decorators to build reliable and maintainable applications.

beginner

How do TypeScript decorators help in NestJS?

Decorators add metadata to classes and methods, making it easy to define routes, inject dependencies, and organize code clearly without extra boilerplate.

intermediate

Why is static typing important in NestJS's TypeScript-first approach?

Static typing helps catch errors early during development, improves code completion, and makes the code easier to understand and maintain.

intermediate

How does NestJS use TypeScript interfaces and classes?

NestJS uses interfaces to define contracts for data shapes and classes to implement services and controllers, ensuring clear structure and type safety.

advanced

What is the benefit of using TypeScript-first philosophy for large NestJS projects?

It improves scalability by making the codebase easier to refactor, reduces bugs with type checks, and enhances developer experience with better tooling support.

What language does NestJS primarily use in its TypeScript-first philosophy?

A TypeScript

B JavaScript

C Python

D Java

NestJS is built to use TypeScript as the main language, taking advantage of its features.

Which feature of TypeScript does NestJS use to add metadata to classes?

A Interfaces

B Enums

C Generics

D Decorators

Decorators allow NestJS to add metadata for routing, dependency injection, and more.

Why is static typing helpful in NestJS development?

A It slows down development

B It catches errors early

C It removes the need for testing

D It makes code run faster

Static typing helps find mistakes before running the code, improving reliability.

In NestJS, what do interfaces mainly define?

A Function implementations

B UI components

C Data shapes and contracts

D Database schemas

Interfaces describe the shape of data and expected structures.

What is a key benefit of the TypeScript-first philosophy for large projects?

A Better scalability and maintainability

B Harder to maintain

C More bugs

D Less tooling support

Using TypeScript helps keep large codebases organized and easier to manage.

Explain the main idea behind the TypeScript-first philosophy in NestJS and why it matters.

Think about how TypeScript features help build better NestJS apps.

Describe how TypeScript features like interfaces and decorators support NestJS development.

Focus on how these features reduce boilerplate and errors.

Practice

1. What is the main benefit of the TypeScript-first philosophy in NestJS?

easy

A. It makes the app run faster at runtime.

B. It removes the need for any testing.

C. It helps catch errors early by using types.

D. It allows writing code without any types.

Solution

1. Step 1: Understand TypeScript's role

   TypeScript adds types to JavaScript, which helps find mistakes before running the code.

2. Step 2: Connect to NestJS philosophy

   NestJS uses TypeScript-first to improve code safety and clarity by leveraging types.

3. Final Answer:

   It helps catch errors early by using types. -> Option C

4. Quick Check:

   TypeScript-first = catch errors early [OK]

Hint: TypeScript-first means using types to find errors early [OK]

Common Mistakes:

• Thinking it makes runtime faster
• Believing it removes need for tests
• Assuming it means no types needed

2. Which of the following is the correct way to define a typed controller method in NestJS using TypeScript-first philosophy?

easy

A. async getUser(): Promise<User> { return this.userService.find(); }

B. async getUser() { return this.userService.find(); }

C. async getUser(): any { return this.userService.find(); }

D. async getUser(): string { return this.userService.find(); }

Solution

1. Step 1: Check method return type

   TypeScript-first means explicitly typing the return value, here Promise<User>.

2. Step 2: Compare options

   async getUser(): Promise<User> { return this.userService.find(); } uses correct typing; others omit or use wrong types like any or string.

3. Final Answer:

   async getUser(): Promise<User> { return this.userService.find(); } -> Option A

4. Quick Check:

   Explicit return type = async getUser(): Promise<User> { return this.userService.find(); } [OK]

Hint: Always specify method return types explicitly [OK]

Common Mistakes:

• Omitting return type annotation
• Using 'any' instead of specific types
• Using wrong return types like string

3. Given this NestJS service method using TypeScript-first philosophy:

async findUser(id: number): Promise {
  const user = await this.userRepository.findOneBy({ id });
  return user ?? null;
}

What is the type of the value returned when no user is found?

medium

A. undefined

B. an empty object {}

C. throws an error

D. null

Solution

1. Step 1: Analyze return statement

   The method returns user ?? null, which means if user is nullish, return null.

2. Step 2: Understand nullish coalescing

   If findOneBy returns undefined, the expression returns null explicitly.

3. Final Answer:

   null -> Option D

4. Quick Check:

   Nullish coalescing returns null if no user [OK]

Hint: ?? operator returns right side if left is null or undefined [OK]

Common Mistakes:

• Assuming undefined is returned
• Thinking an error is thrown
• Expecting empty object instead of null

4. Identify the error in this NestJS controller method using TypeScript-first philosophy:

@Get(':id')
async getUser(@Param('id') id: string): Promise<User> {
  return this.userService.findUser(id);
}

medium

A. The method should not be async if it returns a Promise.

B. The return type should be Promise if user might not exist.

C. The parameter id should be typed as number not string.

D. The decorator @Get is missing a path.

Solution

1. Step 1: Check return type correctness

   If findUser can return null when user not found, the controller must reflect that in its return type.

2. Step 2: Compare options

   The return type should be Promise if user might not exist. correctly points out the return type should allow null. The parameter id should be typed as number not string. is not always true because id can be string if parsed later.

3. Final Answer:

   The return type should be Promise if user might not exist. -> Option B

4. Quick Check:

   Return type must match possible null values [OK]

Hint: Return types must include null if possible [OK]

Common Mistakes:

• Ignoring possible null return
• Thinking async keyword is wrong here
• Assuming @Get needs path always

5. You want to create a NestJS DTO (Data Transfer Object) that enforces a required name string and an optional age number using TypeScript-first philosophy. Which of these is the best TypeScript definition?

hard

A. export class CreateUserDto { name: string; age?: number; }

B. export interface CreateUserDto { name?: string; age: number; }

C. export type CreateUserDto = { name?: string; age?: number; };

D. export class CreateUserDto { name?: string; age: number; }

Solution

1. Step 1: Identify required and optional properties

   The name must be required (no question mark), age optional (with question mark).

2. Step 2: Match with options

   export class CreateUserDto { name: string; age?: number; } correctly defines name as required and age as optional in a class, which is standard for NestJS DTOs.

3. Final Answer:

   export class CreateUserDto { name: string; age?: number; } -> Option A

4. Quick Check:

   Required name, optional age = export class CreateUserDto { name: string; age?: number; } [OK]

Hint: Use '?' for optional properties, omit for required [OK]

Common Mistakes:

• Marking required fields as optional
• Using interface instead of class for DTO
• Making optional fields required