InstanceType type in Typescript

Introduction

The InstanceType type helps you get the type of an object created from a class. It makes it easy to work with instances without repeating code.

When you want to get the type of an object created by a class constructor.

When you want to write functions that accept instances of a class without manually typing the instance shape.

When you want to avoid repeating the instance type and keep your code DRY (Don't Repeat Yourself).

When you want to create variables or parameters that must be instances of a specific class.

Syntax

Typescript

type NewType = InstanceType<typeof ClassName>;

ClassName must be a class or constructor function.

typeof ClassName gets the type of the class itself, and InstanceType extracts the instance type.

Examples

This creates a type DogInstance that matches the type of objects created by Dog.

Typescript

class Dog {
  name: string;
  constructor(name: string) {
    this.name = name;
  }
  bark() {
    return `${this.name} says woof!`;
  }
}

type DogInstance = InstanceType<typeof Dog>;

This function accepts only instances of the Dog class.

Typescript

function greet(dog: InstanceType<typeof Dog>) {
  console.log(dog.bark());
}

Sample Program

This program defines a Car class and uses InstanceType to get the type of its instances. The testDrive function accepts only Car instances and calls the drive method.

Typescript

class Car {
  model: string;
  constructor(model: string) {
    this.model = model;
  }
  drive() {
    return `Driving a ${this.model}`;
  }
}

type CarInstance = InstanceType<typeof Car>;

function testDrive(car: CarInstance) {
  console.log(car.drive());
}

const myCar = new Car('Toyota');
testDrive(myCar);

Important Notes

InstanceType only works with class constructors or constructor functions.

If you use it with something that is not a constructor, TypeScript will give an error.

Summary

InstanceType extracts the type of an instance created by a class.

It helps avoid repeating instance types and keeps code clean.

Use it when you want to type variables or parameters as instances of a class.

Practice

1. What does the TypeScript utility type InstanceType do?

easy

A. Creates a new class instance

B. Extracts the type of an instance created by a class

C. Defines a type alias for primitive types

D. Converts a type to a string

Solution

1. Step 1: Understand the purpose of InstanceType

   InstanceType is a utility type that extracts the type of an object created by a class constructor.

2. Step 2: Compare options with the definition

   Only Extracts the type of an instance created by a class correctly describes this behavior. Options B, C, and D describe unrelated actions.

3. Final Answer:

   Extracts the type of an instance created by a class -> Option B

4. Quick Check:

   InstanceType extracts instance type = A [OK]

Hint: Remember: InstanceType gets the object type from a class [OK]

Common Mistakes:

• Confusing InstanceType with creating instances
• Thinking it converts types to strings
• Assuming it defines primitive types

2. Which of the following is the correct syntax to use InstanceType with a class named Car?

easy

A. type CarInstance = InstanceType;

B. type CarInstance = InstanceType;

C. type CarInstance = InstanceType;

D. type CarInstance = InstanceType<Car>;

Solution

1. Step 1: Recall the syntax of InstanceType

   InstanceType expects a constructor type, so we pass typeof Car to get the class constructor type.

2. Step 2: Analyze each option

   type CarInstance = InstanceType; uses typeof Car, which is correct. type CarInstance = InstanceType<Car>; passes the class itself, which is a value, not a type. Options A, B, and C use invalid syntax.

3. Final Answer:

   type CarInstance = InstanceType; -> Option A

4. Quick Check:

   Use typeof with class name inside InstanceType for correct syntax = D [OK]

Hint: Use typeof ClassName inside InstanceType for correct syntax [OK]

Common Mistakes:

• Passing class name directly without typeof
• Using parentheses after class name
• Trying to instantiate inside InstanceType

3. Given the code below, what is the type of myDog?

class Dog {
  name: string;
  constructor(name: string) {
    this.name = name;
  }
}

let myDog: InstanceType;
myDog = new Dog('Buddy');

medium

A. string

B. { name: string; }

C. typeof Dog

D. Dog

Solution

1. Step 1: Understand what InstanceType means

   It extracts the instance type created by the Dog class constructor, which is the class Dog itself.

2. Step 2: Match the type of myDog

   myDog is typed as an instance of Dog, so its type is Dog (the class instance type). Dog matches this exactly.

3. Final Answer:

   Dog -> Option D

4. Quick Check:

   InstanceType = Dog instance type = A [OK]

Hint: InstanceType equals the class instance type [OK]

Common Mistakes:

• Confusing instance type with constructor type
• Choosing typeof Class instead of instance
• Picking object shape instead of class type

4. Identify the error in the following TypeScript code using InstanceType:

class Cat {
  age: number;
  constructor(age: number) {
    this.age = age;
  }
}

type CatInstance = InstanceType<Cat>;

const kitty: CatInstance = new Cat(3);

medium

A. Missing typeof before Cat in InstanceType

B. Cannot assign new Cat(3) to kitty

C. Cat class must have a method

D. InstanceType cannot be used with classes

Solution

1. Step 1: Check the usage of InstanceType

   InstanceType requires a constructor type, so the class name must be prefixed with typeof.

2. Step 2: Identify the error in the code

   The code uses InstanceType<Cat> instead of InstanceType, causing a type error.

3. Final Answer:

   Missing typeof before Cat in InstanceType -> Option A

4. Quick Check:

   InstanceType needs typeof ClassName = C [OK]

Hint: Always use typeof with class name inside InstanceType [OK]

Common Mistakes:

• Omitting typeof before class name
• Thinking InstanceType works on instances
• Assuming InstanceType works without constructor type

5. You have two classes, Circle and Square. You want to create a function that accepts an instance of either class using InstanceType. Which of the following is the correct way to type the parameter shape?

class Circle {
  radius: number;
  constructor(radius: number) {
    this.radius = radius;
  }
}

class Square {
  side: number;
  constructor(side: number) {
    this.side = side;
  }
}

function drawShape(shape: ???) {
  // drawing logic
}

hard

A. Circle | Square

B. typeof Circle | typeof Square

C. InstanceType | InstanceType

D. InstanceType

Solution

1. Step 1: Understand the goal

   The function should accept instances of Circle or Square, so the parameter type must represent instances, not classes or constructors.

2. Step 2: Analyze each option

   InstanceType | InstanceType correctly uses InstanceType and InstanceType combined with a union to represent instances of both classes. Circle | Square uses class names directly, which are types of instances but does not use InstanceType. typeof Circle | typeof Square uses constructor types, which is incorrect for instances. InstanceType tries to use InstanceType on a union of classes, which is invalid.

3. Final Answer:

   InstanceType | InstanceType -> Option C

4. Quick Check:

   Use InstanceType with typeof for each class, combine with | for union [OK]

Hint: Use InstanceType for each, join with | for multiple classes [OK]

Common Mistakes:

• Using class names without InstanceType
• Using typeof Class instead of InstanceType
• Trying InstanceType on union of classes directly