Readonly utility type in Typescript - Mini Project: Build & Apply

Using the Readonly Utility Type in TypeScript

📖 Scenario: You are creating a simple program to manage a user's profile information. You want to make sure that once the profile data is set, it cannot be changed accidentally.

🎯 Goal: Learn how to use the Readonly utility type in TypeScript to make an object immutable.

📋 What You'll Learn

Create an object with user profile data

Create a readonly version of the user profile object

Try to update the readonly object (should cause error)

Print the readonly user profile object

💡 Why This Matters

🌍 Real World

Readonly types help prevent accidental changes to important data like user profiles, settings, or configuration objects in real applications.

💼 Career

Understanding Readonly and other utility types is important for writing safe and maintainable TypeScript code in professional software development.

1

Create a user profile object

Create a variable called userProfile with type { name: string; age: number; } and assign it the values { name: 'Alice', age: 30 }.

Typescript

# Create the userProfile object with name 'Alice' and age 30
# Your code here

Hint

Use const userProfile: { name: string; age: number; } = { name: 'Alice', age: 30 };

2

Create a readonly version of the user profile

Create a variable called readonlyUserProfile with type Readonly<typeof userProfile> and assign it the value of userProfile.

Typescript

const userProfile: { name: string; age: number; } = { name: 'Alice', age: 30 };
# Create readonlyUserProfile using Readonly
# Your code here

Hint

Use const readonlyUserProfile: Readonly<typeof userProfile> = userProfile;

3

Try to update the readonly user profile

Add a line that tries to change readonlyUserProfile.age to 31. This should cause a TypeScript error because the object is readonly.

Typescript

const userProfile: { name: string; age: number; } = { name: 'Alice', age: 30 };
const readonlyUserProfile: Readonly = userProfile;
# Try to change readonlyUserProfile.age to 31
# Your code here

Hint

Write readonlyUserProfile.age = 31; to see the error.

4

Print the readonly user profile

Write console.log(readonlyUserProfile) to display the readonly user profile object.

Typescript

const userProfile: { name: string; age: number; } = { name: 'Alice', age: 30 };
const readonlyUserProfile: Readonly = userProfile;
// readonlyUserProfile.age = 31; // This line will cause a TypeScript error
# Print readonlyUserProfile
# Your code here

Hint

Use console.log(readonlyUserProfile); to print the object.

Practice

1. What does the Readonly utility type do in TypeScript?

easy

A. Makes all properties optional

B. Allows properties to be changed only once

C. Removes all properties from an object type

D. Makes all properties of an object type unchangeable

Solution

1. Step 1: Understand the purpose of Readonly

   The Readonly utility type is designed to make all properties of an object type immutable, meaning they cannot be changed after initialization.

2. Step 2: Compare with other options

   Options B, C, and D describe behaviors that are not related to Readonly. Only Makes all properties of an object type unchangeable correctly describes making properties unchangeable.

3. Final Answer:

   Makes all properties of an object type unchangeable -> Option D

4. Quick Check:

   Readonly = makes properties unchangeable [OK]

Hint: Readonly means no changes allowed to object properties [OK]

Common Mistakes:

• Thinking Readonly allows one-time changes
• Confusing Readonly with Partial or Required types
• Believing Readonly removes properties

2. Which of the following is the correct syntax to create a readonly type from an interface User?

easy

A. type ReadonlyUser = Readonly<User>();

B. type ReadonlyUser = Readonly<User>;

C. type ReadonlyUser = readonly User;

D. type ReadonlyUser = Readonly<User>[];

Solution

1. Step 1: Recall the syntax of Readonly utility

   The correct syntax to create a readonly version of a type or interface is Readonly<TypeName> without parentheses or array brackets.

2. Step 2: Analyze each option

   type ReadonlyUser = Readonly<User>; uses the correct generic syntax. type ReadonlyUser = Readonly<User>(); incorrectly uses parentheses. type ReadonlyUser = readonly User; uses lowercase 'readonly' which is a keyword for arrays or tuples, not for types. type ReadonlyUser = Readonly<User>[]; creates an array of readonly users, which is different.

3. Final Answer:

   type ReadonlyUser = Readonly<User>; -> Option B

4. Quick Check:

   Readonly syntax = Readonly<Type> [OK]

Hint: Use Readonly<Type> without parentheses or brackets [OK]

Common Mistakes:

• Adding parentheses after Readonly
• Using lowercase 'readonly' instead of utility type
• Confusing array of readonly with readonly type

3. What will be the output of the following TypeScript code?

interface Config {
  url: string;
  timeout: number;
}

const config: Readonly<Config> = { url: 'api.com', timeout: 5000 };

config.timeout = 3000;
console.log(config.timeout);

medium

A. Compilation error

B. 5000

C. 3000

D. undefined

Solution

1. Step 1: Understand Readonly effect on assignment

   The Readonly type makes all properties immutable. Trying to assign a new value to config.timeout will cause a compilation error.

2. Step 2: Check the code behavior

   The line config.timeout = 3000; is invalid and TypeScript will not compile this code, so no runtime output occurs.

3. Final Answer:

   Compilation error -> Option A

4. Quick Check:

   Readonly blocks property assignment = Compilation error [OK]

Hint: Readonly properties cannot be assigned new values [OK]

Common Mistakes:

• Assuming readonly allows property changes
• Expecting old value printed despite error
• Confusing runtime error with compile error

4. Identify the error in this TypeScript code using Readonly and fix it:

interface Point {
  x: number;
  y: number;
}

const p: Readonly<Point> = { x: 10, y: 20 };
p.x = 15;
console.log(p.x);

medium

A. Change p.x = 15; to p = { x: 15, y: 20 };

B. Use as const instead of Readonly

C. Remove Readonly to allow property changes

D. Declare p as let instead of const

Solution

1. Step 1: Identify why assignment fails

   The Readonly type prevents changing properties like p.x</>. The error is caused by trying to assign p.x = 15;.

2. Step 2: Fix by removing Readonly

   Removing Readonly allows property changes. Options A, B, and D do not fix the core problem of property immutability.

3. Final Answer:

   Remove Readonly to allow property changes -> Option C

4. Quick Check:

   Readonly blocks property assignment; remove it to fix [OK]

Hint: Remove Readonly to allow property updates [OK]

Common Mistakes:

• Trying to assign to readonly property instead of removing Readonly
• Using 'as const' which makes object deeply readonly
• Changing variable declaration without fixing immutability

5. Given this nested object type, how can you make all properties readonly including nested ones?

interface Settings {
  theme: string;
  layout: {
    header: boolean;
    footer: boolean;
  };
}

hard

A. Use a custom DeepReadonly type that recursively applies Readonly

B. Use Partial<Settings> to make properties readonly

C. Use readonly Settings keyword

D. Use Readonly<Settings> only

Solution

1. Step 1: Understand shallow vs deep readonly

   The built-in Readonly utility only makes the top-level properties readonly. Nested objects remain mutable.

2. Step 2: Use a recursive DeepReadonly type

   To make nested properties readonly, you need a custom type that applies Readonly recursively to all nested objects.

3. Final Answer:

   Use a custom DeepReadonly type that recursively applies Readonly -> Option A

4. Quick Check:

   Readonly is shallow; use DeepReadonly for nested [OK]

Hint: Readonly is shallow; use recursive type for nested readonly [OK]

Common Mistakes:

• Assuming Readonly makes nested properties readonly
• Using 'readonly' keyword incorrectly on types
• Confusing Partial with Readonly