TransferState for data sharing in Angular

Introduction

TransferState helps share data between server and client in Angular apps. It avoids fetching the same data twice.

When you want to send data fetched on the server to the client without extra requests.

When building Angular Universal apps that render on the server and then continue on the client.

When you want faster page loads by reusing server data on the client side.

When you want to reduce API calls and improve performance in server-side rendered apps.

Syntax

Angular

import { TransferState, makeStateKey } from '@angular/platform-browser';

const KEY = makeStateKey<string>('myDataKey');

// To set data
this.transferState.set(KEY, data);

// To get data
const data = this.transferState.get(KEY, defaultValue);

makeStateKey creates a unique key to store and retrieve data.

Use set on the server to save data, and get on the client to read it.

Examples

Store the string 'Alice' under the key 'user'.

Angular

const USER_KEY = makeStateKey<string>('user');
this.transferState.set(USER_KEY, 'Alice');

Retrieve the 'user' data or return 'Guest' if not found.

Angular

const USER_KEY = makeStateKey<string>('user');
const user = this.transferState.get(USER_KEY, 'Guest');

Store and retrieve a number value using TransferState.

Angular

const COUNT_KEY = makeStateKey<number>('count');
this.transferState.set(COUNT_KEY, 42);
const count = this.transferState.get(COUNT_KEY, 0);

Sample Program

This Angular component uses TransferState to share a string between server and client. On the server, it sets the data. On the client, it reads the data and shows it.

Angular

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

const DATA_KEY = makeStateKey<string>('data');

@Component({
  selector: 'app-root',
  template: `<h1>{{ data }}</h1>`
})
export class AppComponent {
  data = '';

  constructor(
    private transferState: TransferState,
    @Inject(PLATFORM_ID) private platformId: Object
  ) {
    if (isPlatformServer(this.platformId)) {
      // On server: fetch data and store it
      const serverData = 'Hello from server!';
      this.transferState.set(DATA_KEY, serverData);
      this.data = serverData;
    } else {
      // On client: get data from TransferState
      this.data = this.transferState.get(DATA_KEY, 'No data');
      // Remove data after reading to avoid reuse
      this.transferState.remove(DATA_KEY);
    }
  }
}

Important Notes

Always remove data from TransferState on the client after reading to prevent stale data.

TransferState works only with serializable data (like strings, numbers, objects).

Use it mainly in Angular Universal apps where server-side rendering is involved.

Summary

TransferState shares data between server and client to avoid duplicate fetching.

Use makeStateKey to create keys for storing and retrieving data.

Set data on the server and get it on the client for faster, efficient apps.

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