How the TypeScript Omit Type Works

gowebing

TypeScript provides a number of utility types that are used to solve a particular problem that using types in Javascript creates. One very useful utility type used in TypeScript is the Omit type, which lets us customize an already existing type. Let's look at how it works.

Custom Types

This article assumes you know how to create custom types in TypeScript. If you don't, read my article on custom types here.

TypeScript Omit Type

In TypeScript, we often create custom types that let us ensure data conforms to a specific format. For example, if we wanted to create a custom User type that has four fields - firstName, lastName, age and lastActive, we could do something like this:

TypeScript
  
type User = {
  firstName: string;
  lastName: string;
  age: number;
  lastActive: number;
}

Sadly, coding is not always straightforward. Sometimes, we want to use our type again, but remove certain elements from it, thus creating a new type. To do this, we can use Omit<Type, Omissions>. Omit accepts two values:

TypeScript
  
type User = {
  firstName: string;
  lastName: string;
  age: number;
  lastActive: number;
}

type UserNameOnly = Omit<User, "age" | "lastActive">

Now we have two types - User, which is our core user type, and UserNameOnly, which is our User type minus age and lastActive. Similarly, if we only wanted to remove age, this would suffice:

TypeScript
  
type UserNameAndActive = Omit<User, "age">

Now we can use our new types anywhere in our code. This gives us the flexibility to use a type, and transform it for specific circumstances. Here is an example of using both our new types:

TypeScript
  
type User = {
  firstName: string;
  lastName: string;
  age: number;
  lastActive: number;
}

type UserNameOnly = Omit<User, "age" | "lastActive">
type UserNameAndActive = Omit<User, "age">

const userByName:UserNameOnly = {
    firstName: "John",
    lastName: "Doe",
};
const userWithoutAge:UserNameAndActive = {
    firstName: "John",
    lastName: "Doe",
    lastActive: -16302124725
}

 

 

 

 

Top