Excess property checks vs structural compatibility in Typescript

Introduction

We want to make sure objects have the right properties without mistakes. Excess property checks help catch extra wrong properties, while structural compatibility lets objects work if they have the needed parts.

When creating objects that must match a specific shape exactly.

When passing objects to functions expecting certain properties.

When assigning one object to another with similar but not identical properties.

When you want TypeScript to warn about typos in object properties.

When you want flexibility to use objects with extra properties without errors.

Syntax

Typescript

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

const p: Person = { name: "Alice", age: 30, location: "NY" };

Excess property checks happen when you assign an object literal directly to a variable or parameter expecting a specific type.

Structural compatibility means TypeScript checks if an object has at least the required properties, ignoring extra ones when not assigned directly.

Examples

This causes an error because location is not in Person.

Typescript

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

// Excess property check error
const p1: Person = { name: "Bob", age: 25, location: "LA" };

Assigning a variable with extra properties to Person works because of structural compatibility.

Typescript

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

const extra = { name: "Bob", age: 25, location: "LA" };
const p2: Person = extra; // No error here

Passing an object literal with extra property hobby causes an error.

Typescript

function greet(person: Person) {
  console.log(`Hello, ${person.name}`);
}

greet({ name: "Eve", age: 28, hobby: "reading" }); // Error: excess property 'hobby'

Passing a variable with extra properties works fine due to structural compatibility.

Typescript

const obj = { name: "Eve", age: 28, hobby: "reading" };
greet(obj); // No error because obj is a variable

Sample Program

This program shows how excess property checks cause an error when assigning an object literal with extra properties directly. But assigning a variable with extra properties to the expected type works fine.

Typescript

interface Car {
  make: string;
  year: number;
}

// Direct object literal with extra property - error
// const car1: Car = { make: "Toyota", year: 2020, color: "red" };

// Using a variable with extra property - no error
const carDetails = { make: "Toyota", year: 2020, color: "red" };
const car2: Car = carDetails;

console.log(car2.make);
console.log(car2.year);

Important Notes

Excess property checks only happen on fresh object literals assigned directly.

Structural compatibility allows objects with extra properties to be assigned if they come from variables.

You can use type assertions or index signatures to bypass excess property checks if needed.

Summary

Excess property checks catch extra properties in direct object literals to prevent mistakes.

Structural compatibility allows objects with extra properties to be used if assigned from variables.

This helps balance safety and flexibility in TypeScript object typing.

Practice

1. What does TypeScript's excess property checks primarily prevent when assigning an object literal to a variable of a specific type?

easy

A. Assigning object literals with extra properties not defined in the target type

B. Assigning objects with missing properties

C. Assigning objects with incompatible property types

D. Assigning objects with properties in a different order

Solution

1. Step 1: Understand excess property checks context

   Excess property checks happen when assigning an object literal directly to a typed variable.

2. Step 2: Identify what excess property checks prevent

   They prevent extra properties not declared in the target type from being assigned, catching typos or mistakes.

3. Final Answer:

   Assigning object literals with extra properties not defined in the target type -> Option A

4. Quick Check:

   Excess property checks = prevent extra properties [OK]

Hint: Excess checks block extra properties in direct object literals [OK]

Common Mistakes:

• Confusing excess property checks with missing property errors
• Thinking property order matters
• Assuming excess checks apply to variables, not literals

2. Which of the following TypeScript assignments will cause an excess property check error?

easy

A. const obj: {name: string} = {name: 'Dave'} as {name: string};

B. const extra = {name: 'Bob', age: 25}; const obj: {name: string} = extra;

C. const obj: {name: string} = {name: 'Carol'};

D. const obj: {name: string} = {name: 'Alice', age: 30};

Solution

1. Step 1: Check direct object literal assignments

   const obj: {name: string} = {name: 'Alice', age: 30}; assigns a literal with an extra property age directly to a typed variable, triggering excess property checks.

2. Step 2: Compare with other options

   const extra = {name: 'Bob', age: 25}; const obj: {name: string} = extra; assigns from a variable, so excess property checks do not apply. Options C and D have no extra properties.

3. Final Answer:

   const obj: {name: string} = {name: 'Alice', age: 30}; -> Option D

4. Quick Check:

   Direct literal with extra property = error [OK]

Hint: Extra properties in direct literals cause errors, variables do not [OK]

Common Mistakes:

• Thinking variables cause excess property errors
• Ignoring the difference between literals and variables
• Assuming type assertions always cause errors

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

interface Person { name: string; }
const extra = { name: 'Eve', age: 40 };
const p: Person = extra;
console.log(p.name);

medium

A. Runtime error

B. Error: Excess property 'age' not allowed

C. Eve

D. undefined

Solution

1. Step 1: Understand assignment from variable

   Assigning from variable extra bypasses excess property checks, so assignment is allowed.

2. Step 2: Check console output

   Accessing p.name prints 'Eve' as expected.

3. Final Answer:

   Eve -> Option C

4. Quick Check:

   Variable assignment allows extra properties, prints name [OK]

Hint: Variables with extra props assign fine; literals with extras error [OK]

Common Mistakes:

• Expecting excess property error on variable assignment
• Confusing compile-time error with runtime output
• Assuming extra properties are removed

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

interface Car { make: string; }
const car = { make: 'Toyota', year: 2020 };
const myCar: Car = { make: 'Honda', year: 2018 };

medium

A. Error due to extra property 'year' in direct object literal; fix by assigning from variable

B. Error due to missing property 'year'; fix by adding 'year' to interface

C. No error; code is correct

D. Error due to wrong property type; fix by changing 'year' to string

Solution

1. Step 1: Identify excess property check error

   Direct assignment of object literal with extra property year causes error.

2. Step 2: Fix by assigning from variable

   Assigning from variable car avoids excess property checks and fixes error.

3. Final Answer:

   Error due to extra property 'year' in direct object literal; fix by assigning from variable -> Option A

4. Quick Check:

   Direct literal with extra prop = error; use variable [OK]

Hint: Assign extra props via variable, not direct literal [OK]

Common Mistakes:

• Adding extra properties to interface unnecessarily
• Ignoring excess property check rules
• Assuming no error on direct literal with extra props

5. Given this interface and code, which assignment will NOT cause a TypeScript error?

interface User { username: string; }

// Option 1
const u1: User = { username: 'john', email: '[e-mail]' };

// Option 2
const extraUser = { username: 'jane', email: '[e-mail]' };
const u2: User = extraUser;

// Option 3
const u3 = { username: 'doe', email: '[e-mail]' } as User;

// Option 4
const u4: User = { username: 'max' };

hard

A. Only Option 3 and Option 4

B. Only Option 2 and Option 4

C. Only Option 1 and Option 3

D. All options cause errors

Solution

1. Step 1: Analyze Option 1

   Direct literal with extra property email causes excess property check error.

2. Step 2: Analyze Option 2 and 4

   Option 2 assigns from variable, so no error. Option 4 matches interface exactly, no error.

3. Step 3: Analyze Option 3

   Type assertion on direct object literal with extra property email still triggers excess property checks, causing an error.

4. Final Answer:

   Only Option 2 and Option 4 -> Option B

5. Quick Check:

   Direct literal with extras errors; variable assignment and exact match okay [OK]

Hint: Direct literals with extras error; variables and exact matches okay [OK]

Common Mistakes:

• Thinking type assertions bypass excess property checks on object literals
• Thinking all direct literals with extras are allowed
• Ignoring structural compatibility rules