Mapped type with template literals in Typescript - Mini Project: Build & Apply

Mapped type with template literals

📖 Scenario: You are working on a user profile system where you want to create new property names by adding prefixes to existing keys.

🎯 Goal: Create a mapped type that uses template literals to add a prefix to each key of an existing interface.

📋 What You'll Learn

Create an interface called User with keys name and age.

Create a type called PrefixedUser that adds the prefix user_ to each key of User using a mapped type with template literals.

Create a variable prefixedUser of type PrefixedUser with appropriate values.

Print the prefixedUser object.

💡 Why This Matters

🌍 Real World

Adding prefixes or suffixes to keys is useful when integrating with APIs or libraries that require specific naming conventions.

💼 Career

Understanding mapped types and template literals helps in writing flexible and reusable TypeScript code, a valuable skill for frontend and backend developers.

1

Create the User interface

Create an interface called User with two properties: name of type string and age of type number.

Typescript

// Your code here

Hint

Use the interface keyword to define User with the specified properties.

2

Create the PrefixedUser mapped type

Create a mapped type called PrefixedUser that adds the prefix user_ to each key of the User interface using template literals.

Typescript

interface User {
  name: string;
  age: number;
}

// Your code here

Hint

Use keyof User to get keys and template literals to add user_ prefix.

3

Create a variable of type PrefixedUser

Create a variable called prefixedUser of type PrefixedUser and assign it an object with keys user_name set to "Alice" and user_age set to 30.

Typescript

interface User {
  name: string;
  age: number;
}

type PrefixedUser = {
  [K in keyof User as `user_${string & K}`]: User[K];
};

// Your code here

Hint

Make sure the keys match the prefixed keys from PrefixedUser.

4

Print the prefixedUser object

Write a console.log statement to print the prefixedUser object.

Typescript

interface User {
  name: string;
  age: number;
}

type PrefixedUser = {
  [K in keyof User as `user_${string & K}`]: User[K];
};

const prefixedUser: PrefixedUser = {
  user_name: "Alice",
  user_age: 30
};

// Your code here

Hint

Use console.log(prefixedUser) to display the object.

Practice

1.

What does a mapped type with template literals in TypeScript allow you to do?

Example: { [K in keyof T as `get${Capitalize}`]: () => T[K] }

easy

A. Create new variables at runtime

B. Rename keys dynamically in object types

C. Change values of an object at runtime

D. Execute functions based on key names

Solution

1. Step 1: Understand mapped types

   Mapped types create new object types by transforming keys or values of an existing type.

2. Step 2: Role of template literals

   Template literals let you rename keys dynamically by combining strings and key names.

3. Final Answer:

   Rename keys dynamically in object types -> Option B

4. Quick Check:

   Mapped type + template literals = dynamic key renaming [OK]

Hint: Mapped types + template literals = dynamic key renaming [OK]

Common Mistakes:

• Confusing runtime behavior with type transformations
• Thinking it changes object values instead of keys
• Assuming it creates variables or runs code

2.

Which of the following is the correct syntax to rename keys using a mapped type with template literals?

type RenameKeys<T> = { [K in keyof T as ???]: T[K] }

easy

A. `new_${string & K}`

B. `new_${K}`

C. `new_${number & K}`

D. `new_${any & K}`

Solution

1. Step 1: Understand key remapping syntax

   Use as with template literals and intersect key type with string to ensure keys are strings.

2. Step 2: Check each option

   `new_${string & K}` uses string & K which is correct; others use incorrect types like number or any.

3. Final Answer:

   `new_${string & K}` -> Option A

4. Quick Check:

   Use string & K for safe key renaming [OK]

Hint: Use string & K to rename keys safely in template literals [OK]

Common Mistakes:

• Using K directly without string intersection
• Using number or any instead of string & K
• Missing backticks for template literals

3.

What is the resulting type of the following code?

type User = { name: string; age: number };
type PrefixedUser = { [K in keyof User as `get${Capitalize}`]: () => User[K] };

medium

A. { name: () => string; age: () => number }

B. { getName: string; getAge: number }

C. { getname: () => string; getage: () => number }

D. { getName: () => string; getAge: () => number }

Solution

1. Step 1: Analyze key transformation

   Keys 'name' and 'age' are capitalized and prefixed with 'get', becoming 'getName' and 'getAge'.

2. Step 2: Analyze value transformation

   Values become functions returning the original property types: () => string and () => number.

3. Final Answer:

   { getName: () => string; getAge: () => number } -> Option D

4. Quick Check:

   Mapped keys capitalized + function values = { getName: () => string; getAge: () => number } [OK]

Hint: Capitalize keys and prefix with 'get' for function types [OK]

Common Mistakes:

• Not capitalizing keys
• Returning values instead of functions
• Using original keys without prefix

4.

Identify the error in this mapped type using template literals:

type Flags = { isActive: boolean; isAdmin: boolean };
type PrefixedFlags = { [K in keyof Flags as `flag_${K}`]: Flags[K] };

medium

A. Key remapping must use Capitalize utility

B. Cannot use template literals in mapped types

C. Missing string intersection with K in template literal

D. Flags[K] is invalid syntax

Solution

1. Step 1: Check key remapping syntax

   Template literal keys must intersect K with string: string & K to ensure keys are strings.

2. Step 2: Identify missing intersection

   The code uses `flag_${K}` without string & K, causing a type error.

3. Final Answer:

   Missing string intersection with K in template literal -> Option C

4. Quick Check:

   Use string & K in template literals to fix error [OK]

Hint: Always intersect K with string in template literals [OK]

Common Mistakes:

• Omitting string & K intersection
• Thinking Capitalize is mandatory
• Believing template literals can't be used here

5.

Given this type, how would you create a mapped type that prefixes keys with on and capitalizes them, but only for keys starting with handle?

type Handlers = { handleClick: () => void; handleHover: () => void; reset: () => void };

hard

A. type Prefixed = { [K in keyof Handlers as K extends `handle${string}` ? `on${Capitalize}` : never]: Handlers[K] };

B. type Prefixed = { [K in keyof Handlers as `on${Capitalize}`]: Handlers[K] };

C. type Prefixed = { [K in keyof Handlers as K extends string ? `on${Capitalize<K>}` : never]: Handlers[K] };

D. type Prefixed = { [K in keyof Handlers as K extends `on${string}` ? `handle${Capitalize}` : never]: Handlers[K] };

Solution

1. Step 1: Filter keys starting with 'handle'

   Use conditional type K extends `handle${string}` to select only keys starting with 'handle'.

2. Step 2: Rename keys with 'on' prefix and capitalize

   Use template literal `on${Capitalize}` to rename keys accordingly.

3. Step 3: Assign original value types

   Keep the original function types from Handlers[K].

4. Final Answer:

   type Prefixed = { [K in keyof Handlers as K extends `handle${string}` ? `on${Capitalize}` : never]: Handlers[K] }; -> Option A

5. Quick Check:

   Conditional key remapping with prefix and capitalize = type Prefixed = { [K in keyof Handlers as K extends `handle${string}` ? `on${Capitalize}` : never]: Handlers[K] }; [OK]

Hint: Use conditional types to filter keys before renaming [OK]

Common Mistakes:

• Not filtering keys by prefix
• Applying rename to all keys
• Incorrect conditional syntax