TransferState for data sharing in Angular - Mini Project: Build & Apply

Using TransferState for Data Sharing in Angular

📖 Scenario: You are building an Angular app that fetches user profile data from a server. To improve performance and avoid fetching the same data twice, you want to share the fetched data between the server and client using Angular's TransferState service.

🎯 Goal: Build a simple Angular standalone component that fetches user data, stores it in TransferState on the server, and reads it from TransferState on the client to avoid duplicate HTTP calls.

📋 What You'll Learn

Create a user data object with exact properties

Create a TransferState key for storing user data

Use TransferState to save and retrieve user data

Display user name in the component template

💡 Why This Matters

🌍 Real World

TransferState helps Angular apps avoid duplicate data fetching by sharing data fetched on the server with the client, improving load speed and user experience.

💼 Career

Understanding TransferState is important for Angular developers working on server-side rendering and performance optimization.

1

DATA SETUP: Create user data object

Create a constant called userData with an object containing id: 1, name: 'Alice', and email: '[e-mail]'.

Angular

# Your code here

Hint

Use const userData = { id: 1, name: 'Alice', email: '[e-mail]' };

2

CONFIGURATION: Create TransferState key

Create a constant called USER_KEY using makeStateKey<typeof userData>('user-data') to define the TransferState key.

Angular

const userData = { id: 1, name: 'Alice', email: '[e-mail]' };
# Your code here

Hint

Use makeStateKey<typeof userData>('user-data') to create the key.

3

CORE LOGIC: Use TransferState to save and retrieve data

In a standalone Angular component called UserProfileComponent, inject TransferState and PLATFORM_ID. In the constructor, check if the platform is server using isPlatformServer. If server, set userData in TransferState with USER_KEY. If client, get userData from TransferState using USER_KEY. Store the result in a public property called user.

Angular

import { Component, inject, PLATFORM_ID } from '@angular/core';
import { TransferState, makeStateKey } from '@angular/platform-browser';
import { isPlatformServer } from '@angular/common';

const userData = { id: 1, name: 'Alice', email: '[e-mail]' };
const USER_KEY = makeStateKey('user-data');

@Component({
  selector: 'app-user-profile',
  standalone: true,
  template: `User: {{ user.name }}`
})
export class UserProfileComponent {
  user: typeof userData;

  constructor() {
    // Your code here
  }
}

Hint

Use inject to get TransferState and PLATFORM_ID. Use isPlatformServer to check platform. Use set and get methods of TransferState.

4

COMPLETION: Add component to module or bootstrap

Add UserProfileComponent to the bootstrap array in your main Angular module or include it in your app template to display the user name.

Angular

import { bootstrapApplication } from '@angular/platform-browser';
import { UserProfileComponent } from './user-profile.component';

// Your code here

Hint

Use bootstrapApplication(UserProfileComponent) to start the app with this component.

Practice

1. What is the main purpose of Angular's TransferState service?

easy

A. To handle routing between Angular modules

B. To share data between server and client to avoid duplicate HTTP requests

C. To store user preferences in local storage

D. To manage component state within a single client session

Solution

1. Step 1: Understand TransferState's role

   TransferState is designed to transfer data fetched on the server to the client to prevent refetching.

2. Step 2: Compare options

   Only To share data between server and client to avoid duplicate HTTP requests correctly describes this purpose; others describe unrelated features.

3. Final Answer:

   To share data between server and client to avoid duplicate HTTP requests -> Option B

4. Quick Check:

   TransferState purpose = share data server-client [OK]

Hint: Remember TransferState avoids duplicate data fetching [OK]

Common Mistakes:

• Confusing TransferState with client-only state management
• Thinking it manages routing or local storage
• Assuming it only works on the client side

2. Which of the following is the correct way to create a state key using makeStateKey in Angular?

easy

A. const KEY = makeStateKey('userData');

B. const KEY = new StateKey('userData');

C. const KEY = createStateKey('userData');

D. const KEY = StateKey('userData');

Solution

1. Step 1: Recall correct syntax for state key creation

   Angular provides the makeStateKey function to create keys, not a constructor or other function.

2. Step 2: Validate options

   Only const KEY = makeStateKey('userData'); uses makeStateKey correctly with proper syntax.

3. Final Answer:

   const KEY = makeStateKey('userData'); -> Option A

4. Quick Check:

   Use makeStateKey() to create keys [OK]

Hint: Use makeStateKey('name') exactly to create keys [OK]

Common Mistakes:

• Using new keyword with StateKey
• Calling non-existent createStateKey function
• Omitting the function call parentheses

3. Given this Angular code snippet on the server:

const USER_KEY = makeStateKey('user');
this.transferState.set(USER_KEY, { name: 'Alice', age: 30 });

What will this.transferState.get(USER_KEY, null) return on the client?

medium

A. null

B. undefined

C. { name: 'Alice', age: 30 }

D. An error because data cannot be retrieved on client

Solution

1. Step 1: Understand data flow with TransferState

   Data set on the server with set is serialized and available on the client.

2. Step 2: Retrieve data on client

   Calling get with the same key returns the stored object, not null or error.

3. Final Answer:

   { name: 'Alice', age: 30 } -> Option C

4. Quick Check:

   Server set data = client get data [OK]

Hint: Data set on server is available on client with same key [OK]

Common Mistakes:

• Expecting null because of second argument
• Thinking data is undefined on client
• Assuming an error occurs when accessing TransferState on client

4. Identify the error in this Angular code using TransferState:

const DATA_KEY = makeStateKey('data');
this.transferState.set(DATA_KEY, { value: 42 });
const data = this.transferState.get('DATA_KEY', null);

medium

A. The key passed to get() should be the StateKey object, not a string

B. The set() method cannot store objects, only strings

C. makeStateKey should not be used for keys

D. transferState cannot be used outside ngOnInit

Solution

1. Step 1: Check key usage in get()

   The get method requires the same StateKey object used in set, not a string.

2. Step 2: Validate other statements

   Objects can be stored, makeStateKey is correct, and transferState can be used anytime in component lifecycle.

3. Final Answer:

   The key passed to get() should be the StateKey object, not a string -> Option A

4. Quick Check:

   Use same StateKey object for set and get [OK]

Hint: Pass StateKey object, not string, to get() [OK]

Common Mistakes:

• Passing string instead of StateKey to get()
• Thinking set() only accepts strings
• Misunderstanding when transferState can be used

5. You want to optimize your Angular Universal app by sharing a list of products fetched on the server with the client using TransferState. Which approach correctly implements this?

hard

A. On client, set products in TransferState and then fetch from server.

B. On client, always fetch products via HTTP and ignore TransferState.

C. On server, store products in a global variable and access it directly on client.

D. On server, fetch products and call transferState.set(PRODUCTS_KEY, products). On client, retrieve with transferState.get(PRODUCTS_KEY, []) before making HTTP call.

Solution

1. Step 1: Understand TransferState usage for server-client data sharing

   Data fetched on server should be stored in TransferState to avoid client refetch.

2. Step 2: Apply correct flow

   On server, fetch products and call transferState.set(PRODUCTS_KEY, products). On client, retrieve with transferState.get(PRODUCTS_KEY, []) before making HTTP call. correctly sets data on server and retrieves on client before HTTP call, optimizing performance.

3. Step 3: Eliminate incorrect options

   Options B, C, and D misuse TransferState or data flow concepts.

4. Final Answer:

   On server, fetch products and call transferState.set(PRODUCTS_KEY, products). On client, retrieve with transferState.get(PRODUCTS_KEY, []) before making HTTP call. -> Option D

5. Quick Check:

   Server sets data, client gets data before HTTP [OK]

Hint: Set on server, get on client before HTTP call [OK]

Common Mistakes:

• Fetching data again on client ignoring TransferState
• Trying to share data via global variables
• Setting data on client instead of server