The in operator narrowing in Typescript

Introduction

The in operator helps check if an object has a specific property. It lets TypeScript know more about the object's type, so you can use it safely.

When you have an object that could be one of several types and want to check which type it is.

When you want to safely access a property that might not exist on all types.

When you want to avoid errors by confirming a property exists before using it.

When you want clearer and safer code by letting TypeScript narrow down types.

When working with objects from external sources where properties might vary.

Syntax

Typescript

if ("propertyName" in object) {
  // code when property exists
} else {
  // code when property does not exist
}

The property name must be a string or a string literal.

This check narrows the type inside the if block, so you can safely use the property.

Examples

This checks if person has a name property before using it.

Typescript

if ("name" in person) {
  console.log(person.name);
}

Here, we check if vehicle has speed. If yes, we print it; otherwise, we print a message.

Typescript

if ("speed" in vehicle) {
  console.log(vehicle.speed);
} else {
  console.log("No speed property");
}

This function uses in to decide if animal can swim or fly, then calls the right method.

Typescript

type Fish = { swim: () => void };
type Bird = { fly: () => void };

function move(animal: Fish | Bird) {
  if ("swim" in animal) {
    animal.swim();
  } else {
    animal.fly();
  }
}

Sample Program

This program defines two pet types, Cat and Dog. The speak function uses the in operator to check which pet it got and calls the right sound.

Typescript

type Cat = { meow: () => void };
type Dog = { bark: () => void };

function speak(pet: Cat | Dog) {
  if ("meow" in pet) {
    pet.meow();
  } else {
    pet.bark();
  }
}

const myCat: Cat = { meow: () => console.log("Meow!") };
const myDog: Dog = { bark: () => console.log("Woof!") };

speak(myCat);
speak(myDog);

Important Notes

The in operator only checks for property existence, not its value.

It works well with union types to help TypeScript understand which type you have.

Remember to use string literals for property names inside in.

Summary

The in operator checks if an object has a property.

It helps TypeScript narrow down types safely.

Use it to write safer code when working with objects that can be different types.

Practice

1.

What does the in operator do in TypeScript?

easy

A. Adds a new property to an object

B. Checks if a property exists in an object and narrows the type

C. Deletes a property from an object

D. Checks if a value is equal to a property

Solution

1. Step 1: Understand the in operator purpose

   The in operator checks if a given property exists in an object.

2. Step 2: Recognize its use in TypeScript narrowing

   TypeScript uses this check to narrow the type safely based on the presence of the property.

3. Final Answer:

   Checks if a property exists in an object and narrows the type -> Option B

4. Quick Check:

   in operator = property check and type narrowing [OK]

Hint: Remember: in checks property presence to narrow types [OK]

Common Mistakes:

• Thinking in adds or deletes properties
• Confusing in with equality checks
• Assuming in works only for arrays

2.

Which of the following is the correct syntax to check if property name exists in object obj using the in operator?

?

easy

A. "name" in obj

B. obj in "name"

C. obj.hasOwnProperty("name")

D. obj.name in

Solution

1. Step 1: Recall the in operator syntax

   The correct syntax is: "propertyName" in object.

2. Step 2: Match the syntax with options

   "name" in obj matches the correct syntax exactly: "name" in obj.

3. Final Answer:

   "name" in obj -> Option A

4. Quick Check:

   Syntax is "property" in object [OK]

Hint: Syntax is always "property" in object [OK]

Common Mistakes:

• Reversing the order of property and object
• Using method calls instead of in
• Leaving in without operands

3.

What will be the output of the following TypeScript code?

type Fish = { swim: () => void };
type Bird = { fly: () => void };

function move(animal: Fish | Bird) {
  if ("swim" in animal) {
    return "Fish can swim";
  } else {
    return "Bird can fly";
  }
}

console.log(move({ swim: () => {} }));

medium

A. Type error at compile time

B. "Bird can fly"

C. "Fish can swim"

D. Runtime error

Solution

1. Step 1: Analyze the input object

   The object passed has a swim method, so it matches the Fish type.

2. Step 2: Check the in operator condition

   The condition "swim" in animal is true, so the function returns "Fish can swim".

3. Final Answer:

   "Fish can swim" -> Option C

4. Quick Check:

   Property "swim" exists, so output is "Fish can swim" [OK]

Hint: Check which property exists to decide output [OK]

Common Mistakes:

• Confusing which property belongs to which type
• Assuming both properties exist simultaneously
• Expecting compile or runtime errors

4.

Identify the error in this TypeScript code using the in operator and fix it:

type Cat = { meow: () => void };
type Dog = { bark: () => void };

function speak(animal: Cat | Dog) {
  if (animal in "meow") {
    return "Cat speaks";
  } else {
    return "Dog speaks";
  }
}

medium

A. The in operator operands are reversed; should be "meow" in animal

B. Missing return type annotation

C. Function should use typeof instead of in

D. No error; code is correct

Solution

1. Step 1: Check in operator syntax

   The syntax requires the property name as the left operand and the object as the right operand.

2. Step 2: Identify the error in the code

   The code uses animal in "meow", which reverses operands. It should be "meow" in animal.

3. Final Answer:

   The in operator operands are reversed; should be "meow" in animal -> Option A

4. Quick Check:

   Property name must be left, object right in in [OK]

Hint: Remember: "property" in object, not object in "property" [OK]

Common Mistakes:

• Swapping operands of the in operator
• Using typeof instead of in for property checks
• Ignoring TypeScript narrowing benefits

5.

Given the following types and function, what will describeAnimal return when called with { fly: () => {}, name: "Eagle" }?

type Fish = { swim: () => void };
type Bird = { fly: () => void; name: string };

function describeAnimal(animal: Fish | Bird) {
  if ("swim" in animal) {
    return "Fish";
  } else if ("name" in animal) {
    return `Bird named ${animal.name}`;
  } else {
    return "Unknown";
  }
}

hard

A. "Fish"

B. Type error because of missing property

C. "Unknown"

D. "Bird named Eagle"

Solution

1. Step 1: Check the input object properties

   The object has fly and name properties, but no swim.

2. Step 2: Evaluate the in operator conditions

   First condition "swim" in animal is false. Second condition "name" in animal is true, so it returns Bird named Eagle.

3. Final Answer:

   "Bird named Eagle" -> Option D

4. Quick Check:

   Property "name" exists, so output is "Bird named Eagle" [OK]

Hint: Check properties in order to find matching type [OK]

Common Mistakes:

• Assuming presence of fly means Fish
• Ignoring the second in check for name
• Expecting errors due to missing swim