Advanced Types

Table of contents

Intersection Types

Union Types

Type Guards and Differentiating Types

Numeric Literal Types

Enum Member Types

Discriminated Unions

Index types

Intersection Types

An intersection type combines multiple types into one.This allows you to add together existing types to get a single type that has all the features you need.For example, Person & Serializable & Loggable is a Person and Serializable and Loggable.That means an object of this type will have all members of all three types.

You will mostly see intersection types used for mixins and other concepts that don’t fit in the classic object-oriented mold.(There are a lot of these in JavaScript!)Here’s a simple example that shows how to create a mixin:

  1. function extend<First, Second>(first: First, second: Second): First & Second {
  2.     const result: Partial<First & Second> = {};
  3.     for (const prop in first) {
  4.         if (first.hasOwnProperty(prop)) {
  5.             (result as First)[prop] = first[prop];
  6.         }
  7.     }
  8.     for (const prop in second) {
  9.         if (second.hasOwnProperty(prop)) {
  10.             (result as Second)[prop] = second[prop];
  11.         }
  12.     }
  13.     return result as First & Second;
  14. }
  16. class Person {
  17.     constructor(public name: string) { }
  18. }
  20. interface Loggable {
  21.     log(name: string): void;
  22. }
  24. class ConsoleLogger implements Loggable {
  25.     log(name) {
  26.         console.log(`Hello, I'm ${name}.`);
  27.     }
  28. }
  30. const jim = extend(new Person('Jim'), ConsoleLogger.prototype);
  31. jim.log(jim.name);

Union Types

Union types are closely related to intersection types, but they are used very differently.Occasionally, you’ll run into a library that expects a parameter to be either a number or a string.For instance, take the following function:

  1. /**
  2.  * Takes a string and adds "padding" to the left.
  3.  * If 'padding' is a string, then 'padding' is appended to the left side.
  4.  * If 'padding' is a number, then that number of spaces is added to the left side.
  5.  */
  6. function padLeft(value: string, padding: any) {
  7.     if (typeof padding === "number") {
  8.         return Array(padding + 1).join(" ") + value;
  9.     }
  10.     if (typeof padding === "string") {
  11.         return padding + value;
  12.     }
  13.     throw new Error(`Expected string or number, got '${padding}'.`);
  14. }
  16. padLeft("Hello world", 4); // returns "    Hello world"

The problem with padLeft is that its padding parameter is typed as any.That means that we can call it with an argument that’s neither a number nor a string, but TypeScript will be okay with it.

  1. let indentedString = padLeft("Hello world", true); // passes at compile time, fails at runtime.

In traditional object-oriented code, we might abstract over the two types by creating a hierarchy of types.While this is much more explicit, it’s also a little bit overkill.One of the nice things about the original version of padLeft was that we were able to just pass in primitives.That meant that usage was simple and concise.This new approach also wouldn’t help if we were just trying to use a function that already exists elsewhere.

Instead of any, we can use a union type for the padding parameter:

  1. /**
  2.  * Takes a string and adds "padding" to the left.
  3.  * If 'padding' is a string, then 'padding' is appended to the left side.
  4.  * If 'padding' is a number, then that number of spaces is added to the left side.
  5.  */
  6. function padLeft(value: string, padding: string | number) {
  7.     // ...
  8. }
  10. let indentedString = padLeft("Hello world", true); // errors during compilation

A union type describes a value that can be one of several types.We use the vertical bar (|) to separate each type, so number | string | boolean is the type of a value that can be a number, a string, or a boolean.

If we have a value that has a union type, we can only access members that are common to all types in the union.

  1. interface Bird {
  2.     fly();
  3.     layEggs();
  4. }
  6. interface Fish {
  7.     swim();
  8.     layEggs();
  9. }
  11. function getSmallPet(): Fish | Bird {
  12.     // ...
  13. }
  15. let pet = getSmallPet();
  16. pet.layEggs(); // okay
  17. pet.swim();    // errors

Union types can be a bit tricky here, but it just takes a bit of intuition to get used to.If a value has the type A | B, we only know for certain that it has members that both A and B have.In this example, Bird has a member named fly.We can’t be sure whether a variable typed as Bird | Fish has a fly method.If the variable is really a Fish at runtime, then calling pet.fly() will fail.

Type Guards and Differentiating Types

Union types are useful for modeling situations when values can overlap in the types they can take on.What happens when we need to know specifically whether we have a Fish?A common idiom in JavaScript to differentiate between two possible values is to check for the presence of a member.As we mentioned, you can only access members that are guaranteed to be in all the constituents of a union type.

  1. let pet = getSmallPet();
  3. // Each of these property accesses will cause an error
  4. if (pet.swim) {
  5.     pet.swim();
  6. }
  7. else if (pet.fly) {
  8.     pet.fly();
  9. }

To get the same code working, we’ll need to use a type assertion:

  1. let pet = getSmallPet();
  3. if ((pet as Fish).swim) {
  4.     (pet as Fish).swim();
  5. } else if ((pet as Bird).fly) {
  6.     (pet as Bird).fly();
  7. }

User-Defined Type Guards

Notice that we had to use type assertions several times.It would be much better if once we performed the check, we could know the type of pet within each branch.

It just so happens that TypeScript has something called a type guard.A type guard is some expression that performs a runtime check that guarantees the type in some scope.

Using type predicates

To define a type guard, we simply need to define a function whose return type is a type predicate:

  1. function isFish(pet: Fish | Bird): pet is Fish {
  2.     return (pet as Fish).swim !== undefined;
  3. }

pet is Fish is our type predicate in this example.A predicate takes the form parameterName is Type, where parameterName must be the name of a parameter from the current function signature.

Any time isFish is called with some variable, TypeScript will narrow that variable to that specific type if the original type is compatible.

  1. // Both calls to 'swim' and 'fly' are now okay.
  3. if (isFish(pet)) {
  4.     pet.swim();
  5. }
  6. else {
  7.     pet.fly();
  8. }

Notice that TypeScript not only knows that pet is a Fish in the if branch;it also knows that in the else branch, you don’t have a Fish, so you must have a Bird.

Using the in operator

The in operator now acts as a narrowing expression for types.

For a n in x expression, where n is a string literal or string literal type and x is a union type, the “true” branch narrows to types which have an optional or required property n, and the “false” branch narrows to types which have an optional or missing property n.

  1. function move(pet: Fish | Bird) {
  2.     if ("swim" in pet) {
  3.         return pet.swim();
  4.     }
  5.     return pet.fly();
  6. }

typeof type guards

Let’s go back and write the code for the version of padLeft that uses union types.We could write it with type predicates as follows:

  1. function isNumber(x: any): x is number {
  2.     return typeof x === "number";
  3. }
  5. function isString(x: any): x is string {
  6.     return typeof x === "string";
  7. }
  9. function padLeft(value: string, padding: string | number) {
  10.     if (isNumber(padding)) {
  11.         return Array(padding + 1).join(" ") + value;
  12.     }
  13.     if (isString(padding)) {
  14.         return padding + value;
  15.     }
  16.     throw new Error(`Expected string or number, got '${padding}'.`);
  17. }

However, having to define a function to figure out if a type is a primitive is kind of a pain.Luckily, you don’t need to abstract typeof x === "number" into its own function because TypeScript will recognize it as a type guard on its own.That means we could just write these checks inline.

  1. function padLeft(value: string, padding: string | number) {
  2.     if (typeof padding === "number") {
  3.         return Array(padding + 1).join(" ") + value;
  4.     }
  5.     if (typeof padding === "string") {
  6.         return padding + value;
  7.     }
  8.     throw new Error(`Expected string or number, got '${padding}'.`);
  9. }

These typeof type guards are recognized in two different forms: typeof v === "typename" and typeof v !== "typename", where "typename" must be "number", "string", "boolean", or "symbol".While TypeScript won’t stop you from comparing to other strings, the language won’t recognize those expressions as type guards.

instanceof type guards

If you’ve read about typeof type guards and are familiar with the instanceof operator in JavaScript, you probably have some idea of what this section is about.

instanceof type guards are a way of narrowing types using their constructor function.For instance, let’s borrow our industrial string-padder example from earlier:

  1. interface Padder {
  2.     getPaddingString(): string
  3. }
  5. class SpaceRepeatingPadder implements Padder {
  6.     constructor(private numSpaces: number) { }
  7.     getPaddingString() {
  8.         return Array(this.numSpaces + 1).join(" ");
  9.     }
  10. }
  12. class StringPadder implements Padder {
  13.     constructor(private value: string) { }
  14.     getPaddingString() {
  15.         return this.value;
  16.     }
  17. }
  19. function getRandomPadder() {
  20.     return Math.random() < 0.5 ?
  21.         new SpaceRepeatingPadder(4) :
  22.         new StringPadder("  ");
  23. }
  25. // Type is 'SpaceRepeatingPadder | StringPadder'
  26. let padder: Padder = getRandomPadder();
  28. if (padder instanceof SpaceRepeatingPadder) {
  29.     padder; // type narrowed to 'SpaceRepeatingPadder'
  30. }
  31. if (padder instanceof StringPadder) {
  32.     padder; // type narrowed to 'StringPadder'
  33. }

The right side of the instanceof needs to be a constructor function, and TypeScript will narrow down to:

  • the type of the function’s prototype property if its type is not any
  • the union of types returned by that type’s construct signaturesin that order.

Nullable types

TypeScript has two special types, null and undefined, that have the values null and undefined respectively.We mentioned these briefly in the Basic Types section.By default, the type checker considers null and undefined assignable to anything.Effectively, null and undefined are valid values of every type.That means it’s not possible to stop them from being assigned to any type, even when you would like to prevent it.The inventor of null, Tony Hoare, calls this his “billion dollar mistake”.

The —strictNullChecks flag fixes this: when you declare a variable, it doesn’t automatically include null or undefined.You can include them explicitly using a union type:

  1. let s = "foo";
  2. s = null; // error, 'null' is not assignable to 'string'
  3. let sn: string | null = "bar";
  4. sn = null; // ok
  6. sn = undefined; // error, 'undefined' is not assignable to 'string | null'

Note that TypeScript treats null and undefined differently in order to match JavaScript semantics.string | null is a different type than string | undefined and string | undefined | null.

From TypeScript 3.7 and onwards, you can use optional chaining to simplify working with nullable types.

Optional parameters and properties

With —strictNullChecks, an optional parameter automatically adds | undefined:

  1. function f(x: number, y?: number) {
  2.     return x + (y || 0);
  3. }
  4. f(1, 2);
  5. f(1);
  6. f(1, undefined);
  7. f(1, null); // error, 'null' is not assignable to 'number | undefined'

The same is true for optional properties:

  1. class C {
  2.     a: number;
  3.     b?: number;
  4. }
  5. let c = new C();
  6. c.a = 12;
  7. c.a = undefined; // error, 'undefined' is not assignable to 'number'
  8. c.b = 13;
  9. c.b = undefined; // ok
  10. c.b = null; // error, 'null' is not assignable to 'number | undefined'

Type guards and type assertions

Since nullable types are implemented with a union, you need to use a type guard to get rid of the null.Fortunately, this is the same code you’d write in JavaScript:

  1. function f(sn: string | null): string {
  2.     if (sn == null) {
  3.         return "default";
  4.     }
  5.     else {
  6.         return sn;
  7.     }
  8. }

The null elimination is pretty obvious here, but you can use terser operators too:

  1. function f(sn: string | null): string {
  2.     return sn || "default";
  3. }

In cases where the compiler can’t eliminate null or undefined, you can use the type assertion operator to manually remove them.The syntax is postfix !: identifier! removes null and undefined from the type of identifier:

  1. function broken(name: string | null): string {
  2.   function postfix(epithet: string) {
  3.     return name.charAt(0) + '.  the ' + epithet; // error, 'name' is possibly null
  4.   }
  5.   name = name || "Bob";
  6.   return postfix("great");
  7. }
  9. function fixed(name: string | null): string {
  10.   function postfix(epithet: string) {
  11.     return name!.charAt(0) + '.  the ' + epithet; // ok
  12.   }
  13.   name = name || "Bob";
  14.   return postfix("great");
  15. }

The example uses a nested function here because the compiler can’t eliminate nulls inside a nested function (except immediately-invoked function expressions).That’s because it can’t track all calls to the nested function, especially if you return it from the outer function.Without knowing where the function is called, it can’t know what the type of name will be at the time the body executes.

Type Aliases

Type aliases create a new name for a type.Type aliases are sometimes similar to interfaces, but can name primitives, unions, tuples, and any other types that you’d otherwise have to write by hand.

  1. type Name = string;
  2. type NameResolver = () => string;
  3. type NameOrResolver = Name | NameResolver;
  4. function getName(n: NameOrResolver): Name {
  5.     if (typeof n === "string") {
  6.         return n;
  7.     }
  8.     else {
  9.         return n();
  10.     }
  11. }

Aliasing doesn’t actually create a new type - it creates a new name to refer to that type.Aliasing a primitive is not terribly useful, though it can be used as a form of documentation.

Just like interfaces, type aliases can also be generic - we can just add type parameters and use them on the right side of the alias declaration:

  1. type Container<T> = { value: T };

We can also have a type alias refer to itself in a property:

  1. type Tree<T> = {
  2.     value: T;
  3.     left: Tree<T>;
  4.     right: Tree<T>;
  5. }

Together with intersection types, we can make some pretty mind-bending types:

  1. type LinkedList<T> = T & { next: LinkedList<T> };
  3. interface Person {
  4.     name: string;
  5. }
  7. var people: LinkedList<Person>;
  8. var s = people.name;
  9. var s = people.next.name;
  10. var s = people.next.next.name;
  11. var s = people.next.next.next.name;

However, it’s not possible for a type alias to appear anywhere else on the right side of the declaration:

  1. type Yikes = Array<Yikes>; // error

Interfaces vs. Type Aliases

As we mentioned, type aliases can act sort of like interfaces; however, there are some subtle differences.

One difference is that interfaces create a new name that is used everywhere.Type aliases don’t create a new name — for instance, error messages won’t use the alias name.In the code below, hovering over interfaced in an editor will show that it returns an Interface, but will show that aliased returns object literal type.

  1. type Alias = { num: number }
  2. interface Interface {
  3.     num: number;
  4. }
  5. declare function aliased(arg: Alias): Alias;
  6. declare function interfaced(arg: Interface): Interface;

In older versions of TypeScript, type aliases couldn’t be extended or implemented from (nor could they extend/implement other types). As of version 2.7, type aliases can be extended by creating a new intersection type e.g. type Cat = Animal & { purrs: true }.

Because an ideal property of software is being open to extension, you should always use an interface over a type alias if possible.

On the other hand, if you can’t express some shape with an interface and you need to use a union or tuple type, type aliases are usually the way to go.

String Literal Types

String literal types allow you to specify the exact value a string must have.In practice string literal types combine nicely with union types, type guards, and type aliases.You can use these features together to get enum-like behavior with strings.

  1. type Easing = "ease-in" | "ease-out" | "ease-in-out";
  2. class UIElement {
  3.     animate(dx: number, dy: number, easing: Easing) {
  4.         if (easing === "ease-in") {
  5.             // ...
  6.         }
  7.         else if (easing === "ease-out") {
  8.         }
  9.         else if (easing === "ease-in-out") {
  10.         }
  11.         else {
  12.             // error! should not pass null or undefined.
  13.         }
  14.     }
  15. }
  17. let button = new UIElement();
  18. button.animate(0, 0, "ease-in");
  19. button.animate(0, 0, "uneasy"); // error: "uneasy" is not allowed here

You can pass any of the three allowed strings, but any other string will give the error

  1. Argument of type '"uneasy"' is not assignable to parameter of type '"ease-in" | "ease-out" | "ease-in-out"'

String literal types can be used in the same way to distinguish overloads:

  1. function createElement(tagName: "img"): HTMLImageElement;
  2. function createElement(tagName: "input"): HTMLInputElement;
  3. // ... more overloads ...
  4. function createElement(tagName: string): Element {
  5.     // ... code goes here ...
  6. }

Numeric Literal Types

TypeScript also has numeric literal types.

  1. function rollDice(): 1 | 2 | 3 | 4 | 5 | 6 {
  2.     // ...
  3. }

These are seldom written explicitly, they can be useful when narrowing can catch bugs:

  1. function foo(x: number) {
  2.     if (x !== 1 || x !== 2) {
  3.         //         ~~~~~~~
  4.         // Operator '!==' cannot be applied to types '1' and '2'.
  5.     }
  6. }

In other words, x must be 1 when it gets compared to 2, meaning that the above check is making an invalid comparison.

Enum Member Types

As mentioned in our section on enums, enum members have types when every member is literal-initialized.

Much of the time when we talk about “singleton types”, we’re referring to both enum member types as well as numeric/string literal types, though many users will use “singleton types” and “literal types” interchangeably.

Discriminated Unions

You can combine singleton types, union types, type guards, and type aliases to build an advanced pattern called discriminated unions, also known as tagged unions or algebraic data types.Discriminated unions are useful in functional programming.Some languages automatically discriminate unions for you; TypeScript instead builds on JavaScript patterns as they exist today.There are three ingredients:

  • Types that have a common, singleton type property — the discriminant.
  • A type alias that takes the union of those types — the union.
  • Type guards on the common property.
  1. interface Square {
  2.     kind: "square";
  3.     size: number;
  4. }
  5. interface Rectangle {
  6.     kind: "rectangle";
  7.     width: number;
  8.     height: number;
  9. }
  10. interface Circle {
  11.     kind: "circle";
  12.     radius: number;
  13. }

First we declare the interfaces we will union.Each interface has a kind property with a different string literal type.The kind property is called the discriminant or tag.The other properties are specific to each interface.Notice that the interfaces are currently unrelated.Let’s put them into a union:

  1. type Shape = Square | Rectangle | Circle;

Now let’s use the discriminated union:

  1. function area(s: Shape) {
  2.     switch (s.kind) {
  3.         case "square": return s.size * s.size;
  4.         case "rectangle": return s.height * s.width;
  5.         case "circle": return Math.PI * s.radius ** 2;
  6.     }
  7. }

Exhaustiveness checking

We would like the compiler to tell us when we don’t cover all variants of the discriminated union.For example, if we add Triangle to Shape, we need to update area as well:

  1. type Shape = Square | Rectangle | Circle | Triangle;
  2. function area(s: Shape) {
  3.     switch (s.kind) {
  4.         case "square": return s.size * s.size;
  5.         case "rectangle": return s.height * s.width;
  6.         case "circle": return Math.PI * s.radius ** 2;
  7.     }
  8.     // should error here - we didn't handle case "triangle"
  9. }

There are two ways to do this.The first is to turn on —strictNullChecks and specify a return type:

  1. function area(s: Shape): number { // error: returns number | undefined
  2.     switch (s.kind) {
  3.         case "square": return s.size * s.size;
  4.         case "rectangle": return s.height * s.width;
  5.         case "circle": return Math.PI * s.radius ** 2;
  6.     }
  7. }

Because the switch is no longer exhaustive, TypeScript is aware that the function could sometimes return undefined.If you have an explicit return type number, then you will get an error that the return type is actually number | undefined.However, this method is quite subtle and, besides, —strictNullChecks does not always work with old code.

The second method uses the never type that the compiler uses to check for exhaustiveness:

  1. function assertNever(x: never): never {
  2.     throw new Error("Unexpected object: " + x);
  3. }
  4. function area(s: Shape) {
  5.     switch (s.kind) {
  6.         case "square": return s.size * s.size;
  7.         case "rectangle": return s.height * s.width;
  8.         case "circle": return Math.PI * s.radius ** 2;
  9.         default: return assertNever(s); // error here if there are missing cases
  10.     }
  11. }

Here, assertNever checks that s is of type never — the type that’s left after all other cases have been removed.If you forget a case, then s will have a real type and you will get a type error.This method requires you to define an extra function, but it’s much more obvious when you forget it.

Polymorphic this types

A polymorphic this type represents a type that is the subtype of the containing class or interface.This is called F-bounded polymorphism.This makes hierarchical fluent interfaces much easier to express, for example.Take a simple calculator that returns this after each operation:

  1. class BasicCalculator {
  2.     public constructor(protected value: number = 0) { }
  3.     public currentValue(): number {
  4.         return this.value;
  5.     }
  6.     public add(operand: number): this {
  7.         this.value += operand;
  8.         return this;
  9.     }
  10.     public multiply(operand: number): this {
  11.         this.value *= operand;
  12.         return this;
  13.     }
  14.     // ... other operations go here ...
  15. }
  17. let v = new BasicCalculator(2)
  18.             .multiply(5)
  19.             .add(1)
  20.             .currentValue();

Since the class uses this types, you can extend it and the new class can use the old methods with no changes.

  1. class ScientificCalculator extends BasicCalculator {
  2.     public constructor(value = 0) {
  3.         super(value);
  4.     }
  5.     public sin() {
  6.         this.value = Math.sin(this.value);
  7.         return this;
  8.     }
  9.     // ... other operations go here ...
  10. }
  12. let v = new ScientificCalculator(2)
  13.         .multiply(5)
  14.         .sin()
  15.         .add(1)
  16.         .currentValue();

Without this types, ScientificCalculator would not have been able to extend BasicCalculator and keep the fluent interface.multiply would have returned BasicCalculator, which doesn’t have the sin method.However, with this types, multiply returns this, which is ScientificCalculator here.

Index types

With index types, you can get the compiler to check code that uses dynamic property names.For example, a common JavaScript pattern is to pick a subset of properties from an object:

  1. function pluck(o, propertyNames) {
  2.     return propertyNames.map(n => o[n]);
  3. }

Here’s how you would write and use this function in TypeScript, using the index type query and indexed access operators:

  1. function pluck<T, K extends keyof T>(o: T, propertyNames: K[]): T[K][] {
  2.   return propertyNames.map(n => o[n]);
  3. }
  5. interface Car {
  6.     manufacturer: string;
  7.     model: string;
  8.     year: number;
  9. }
  10. let taxi: Car = {
  11.     manufacturer: 'Toyota',
  12.     model: 'Camry',
  13.     year: 2014
  14. };
  16. // Manufacturer and model are both of type string,
  17. // so we can pluck them both into a typed string array
  18. let makeAndModel: string[] = pluck(taxi, ['manufacturer', 'model']);
  20. // If we try to pluck model and year, we get an
  21. // array of a union type: (string | number)[]
  22. let modelYear = pluck(taxi, ['model', 'year'])

The compiler checks that manufacturer and model are actually properties on Car.The example introduces a couple of new type operators.First is keyof T, the index type query operator.For any type T, keyof T is the union of known, public property names of T.For example:

  1. let carProps: keyof Car; // the union of ('manufacturer' | 'model' | 'year')

keyof Car is completely interchangeable with 'manufacturer' | 'model' | 'year'.The difference is that if you add another property to Car, say ownersAddress: string, then keyof Car will automatically update to be 'manufacturer' | 'model' | 'year' | 'ownersAddress'.And you can use keyof in generic contexts like pluck, where you can’t possibly know the property names ahead of time.That means the compiler will check that you pass the right set of property names to pluck:

  1. // error, 'unknown' is not in 'manufacturer' | 'model' | 'year'
  2. pluck(taxi, ['year', 'unknown']); /

The second operator is T[K], the indexed access operator.Here, the type syntax reflects the expression syntax.That means that person['name'] has the type Person['name'] — which in our example is just string.However, just like index type queries, you can use T[K] in a generic context, which is where its real power comes to life.You just have to make sure that the type variable K extends keyof T.Here’s another example with a function named getProperty.

  1. function getProperty<T, K extends keyof T>(o: T, propertyName: K): T[K] {
  2.     return o[propertyName]; // o[propertyName] is of type T[K]
  3. }

In getProperty, o: T and propertyName: K, so that means o[propertyName]: T[K].Once you return the T[K] result, the compiler will instantiate the actual type of the key, so the return type of getProperty will vary according to which property you request.

  1. let name: string = getProperty(taxi, 'manufacturer');
  2. let year: number = getProperty(taxi, 'year');
  4. // error, 'unknown' is not in 'manufacturer' | 'model' | 'year'
  5. let unknown = getProperty(taxi, 'unknown');

Index types and index signatures

keyof and T[K] interact with index signatures. An index signature parameter type must be ‘string’ or ‘number’.If you have a type with a string index signature, keyof T will be string | number(and not just string, since in JavaScript you can access an object property eitherby using strings (object['42']) or numbers (object[42])).And T[string] is just the type of the index signature:

  1. interface Dictionary<T> {
  2.     [key: string]: T;
  3. }
  4. let keys: keyof Dictionary<number>; // string | number
  5. let value: Dictionary<number>['foo']; // number

If you have a type with a number index signature, keyof T will just be number.

  1. interface Dictionary<T> {
  2.     [key: number]: T;
  3. }
  4. let keys: keyof Dictionary<number>; // number
  5. let value: Dictionary<number>['foo']; // Error, Property 'foo' does not exist on type 'Dictionary<number>'.
  6. let value: Dictionary<number>[42]; // number

Mapped types

A common task is to take an existing type and make each of its properties optional:

  1. interface PersonPartial {
  2.     name?: string;
  3.     age?: number;
  4. }

Or we might want a readonly version:

  1. interface PersonReadonly {
  2.     readonly name: string;
  3.     readonly age: number;
  4. }

This happens often enough in JavaScript that TypeScript provides a way to create new types based on old types — mapped types.In a mapped type, the new type transforms each property in the old type in the same way.For example, you can make all properties of a type readonly or optional.Here are a couple of examples:

  1. type Readonly<T> = {
  2.     readonly [P in keyof T]: T[P];
  3. }
  4. type Partial<T> = {
  5.     [P in keyof T]?: T[P];
  6. }

And to use it:

  1. type PersonPartial = Partial<Person>;
  2. type ReadonlyPerson = Readonly<Person>;

Note that this syntax describes a type rather than a member.If you want to add members, you can use an intersection type:

  1. // Use this:
  2. type PartialWithNewMember<T> = {
  3.   [P in keyof T]?: T[P];
  4. } & { newMember: boolean }
  6. // **Do not** use the following!
  7. // This is an error!
  8. type PartialWithNewMember<T> = {
  9.   [P in keyof T]?: T[P];
  10.   newMember: boolean;
  11. }

Let’s take a look at the simplest mapped type and its parts:

  1. type Keys = 'option1' | 'option2';
  2. type Flags = { [K in Keys]: boolean };

The syntax resembles the syntax for index signatures with a for .. in inside.There are three parts:

  • The type variable K, which gets bound to each property in turn.
  • The string literal union Keys, which contains the names of properties to iterate over.
  • The resulting type of the property.In this simple example, Keys is a hard-coded list of property names and the property type is always boolean, so this mapped type is equivalent to writing:
  1. type Flags = {
  2.     option1: boolean;
  3.     option2: boolean;
  4. }

Real applications, however, look like Readonly or Partial above.They’re based on some existing type, and they transform the properties in some way.That’s where keyof and indexed access types come in:

  1. type NullablePerson = { [P in keyof Person]: Person[P] | null }
  2. type PartialPerson = { [P in keyof Person]?: Person[P] }

But it’s more useful to have a general version.

  1. type Nullable<T> = { [P in keyof T]: T[P] | null }
  2. type Partial<T> = { [P in keyof T]?: T[P] }

In these examples, the properties list is keyof T and the resulting type is some variant of T[P].This is a good template for any general use of mapped types.That’s because this kind of transformation is homomorphic, which means that the mapping applies only to properties of T and no others.The compiler knows that it can copy all the existing property modifiers before adding any new ones.For example, if Person.name was readonly, Partial<Person>.name would be readonly and optional.

Here’s one more example, in which T[P] is wrapped in a Proxy<T> class:

  1. type Proxy<T> = {
  2.     get(): T;
  3.     set(value: T): void;
  4. }
  5. type Proxify<T> = {
  6.     [P in keyof T]: Proxy<T[P]>;
  7. }
  8. function proxify<T>(o: T): Proxify<T> {
  9.    // ... wrap proxies ...
  10. }
  11. let proxyProps = proxify(props);

Note that Readonly<T> and Partial<T> are so useful, they are included in TypeScript’s standard library along with Pick and Record:

  1. type Pick<T, K extends keyof T> = {
  2.     [P in K]: T[P];
  3. }
  4. type Record<K extends keyof any, T> = {
  5.     [P in K]: T;
  6. }

Readonly, Partial and Pick are homomorphic whereas Record is not.One clue that Record is not homomorphic is that it doesn’t take an input type to copy properties from:

  1. type ThreeStringProps = Record<'prop1' | 'prop2' | 'prop3', string>

Non-homomorphic types are essentially creating new properties, so they can’t copy property modifiers from anywhere.

Inference from mapped types

Now that you know how to wrap the properties of a type, the next thing you’ll want to do is unwrap them.Fortunately, that’s pretty easy:

  1. function unproxify<T>(t: Proxify<T>): T {
  2.     let result = {} as T;
  3.     for (const k in t) {
  4.         result[k] = t[k].get();
  5.     }
  6.     return result;
  7. }
  9. let originalProps = unproxify(proxyProps);

Note that this unwrapping inference only works on homomorphic mapped types.If the mapped type is not homomorphic you’ll have to give an explicit type parameter to your unwrapping function.

Conditional Types

TypeScript 2.8 introduces conditional types which add the ability to express non-uniform type mappings.A conditional type selects one of two possible types based on a condition expressed as a type relationship test:

  1. T extends U ? X : Y

The type above means when T is assignable to U the type is X, otherwise the type is Y.

A conditional type T extends U ? X : Y is either resolved to X or Y, or deferred because the condition depends on one or more type variables.When T or U contains type variables, whether to resolve to X or Y, or to defer, is determined by whether or not the type system has enough information to conclude that T is always assignable to U.

As an example of some types that are immediately resolved, we can take a look at the following example:

  1. declare function f<T extends boolean>(x: T): T extends true ? string : number;
  3. // Type is 'string | number
  4. let x = f(Math.random() < 0.5)

Another example would be the TypeName type alias, which uses nested conditional types:

  1. type TypeName<T> =
  2.     T extends string ? "string" :
  3.     T extends number ? "number" :
  4.     T extends boolean ? "boolean" :
  5.     T extends undefined ? "undefined" :
  6.     T extends Function ? "function" :
  7.     "object";
  9. type T0 = TypeName<string>;  // "string"
  10. type T1 = TypeName<"a">;  // "string"
  11. type T2 = TypeName<true>;  // "boolean"
  12. type T3 = TypeName<() => void>;  // "function"
  13. type T4 = TypeName<string[]>;  // "object"

But as an example of a place where conditional types are deferred - where they stick around instead of picking a branch - would be in the following:

  1. interface Foo {
  2.     propA: boolean;
  3.     propB: boolean;
  4. }
  6. declare function f<T>(x: T): T extends Foo ? string : number;
  8. function foo<U>(x: U) {
  9.     // Has type 'U extends Foo ? string : number'
  10.     let a = f(x);
  12.     // This assignment is allowed though!
  13.     let b: string | number = a;
  14. }

In the above, the variable a has a conditional type that hasn’t yet chosen a branch.When another piece of code ends up calling foo, it will substitute in U with some other type, and TypeScript will re-evaluate the conditional type, deciding whether it can actually pick a branch.

In the meantime, we can assign a conditional type to any other target type as long as each branch of the conditional is assignable to that target.So in our example above we were able to assign U extends Foo ? string : number to string | number since no matter what the conditional evaluates to, it’s known to be either string or number.

Distributive conditional types

Conditional types in which the checked type is a naked type parameter are called distributive conditional types.Distributive conditional types are automatically distributed over union types during instantiation.For example, an instantiation of T extends U ? X : Y with the type argument A | B | C for T is resolved as (A extends U ? X : Y) | (B extends U ? X : Y) | (C extends U ? X : Y).

Example

  1. type T10 = TypeName<string | (() => void)>;  // "string" | "function"
  2. type T12 = TypeName<string | string[] | undefined>;  // "string" | "object" | "undefined"
  3. type T11 = TypeName<string[] | number[]>;  // "object"

In instantiations of a distributive conditional type T extends U ? X : Y, references to T within the conditional type are resolved to individual constituents of the union type (i.e. T refers to the individual constituents after the conditional type is distributed over the union type).Furthermore, references to T within X have an additional type parameter constraint U (i.e. T is considered assignable to U within X).

Example

  1. type BoxedValue<T> = { value: T };
  2. type BoxedArray<T> = { array: T[] };
  3. type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;
  5. type T20 = Boxed<string>;  // BoxedValue<string>;
  6. type T21 = Boxed<number[]>;  // BoxedArray<number>;
  7. type T22 = Boxed<string | number[]>;  // BoxedValue<string> | BoxedArray<number>;

Notice that T has the additional constraint any[] within the true branch of Boxed<T> and it is therefore possible to refer to the element type of the array as T[number]. Also, notice how the conditional type is distributed over the union type in the last example.

The distributive property of conditional types can conveniently be used to filter union types:

  1. type Diff<T, U> = T extends U ? never : T;  // Remove types from T that are assignable to U
  2. type Filter<T, U> = T extends U ? T : never;  // Remove types from T that are not assignable to U
  4. type T30 = Diff<"a" | "b" | "c" | "d", "a" | "c" | "f">;  // "b" | "d"
  5. type T31 = Filter<"a" | "b" | "c" | "d", "a" | "c" | "f">;  // "a" | "c"
  6. type T32 = Diff<string | number | (() => void), Function>;  // string | number
  7. type T33 = Filter<string | number | (() => void), Function>;  // () => void
  9. type NonNullable<T> = Diff<T, null | undefined>;  // Remove null and undefined from T
  11. type T34 = NonNullable<string | number | undefined>;  // string | number
  12. type T35 = NonNullable<string | string[] | null | undefined>;  // string | string[]
  14. function f1<T>(x: T, y: NonNullable<T>) {
  15.     x = y;  // Ok
  16.     y = x;  // Error
  17. }
  19. function f2<T extends string | undefined>(x: T, y: NonNullable<T>) {
  20.     x = y;  // Ok
  21.     y = x;  // Error
  22.     let s1: string = x;  // Error
  23.     let s2: string = y;  // Ok
  24. }

Conditional types are particularly useful when combined with mapped types:

  1. type FunctionPropertyNames<T> = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T];
  2. type FunctionProperties<T> = Pick<T, FunctionPropertyNames<T>>;
  4. type NonFunctionPropertyNames<T> = { [K in keyof T]: T[K] extends Function ? never : K }[keyof T];
  5. type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;
  7. interface Part {
  8.     id: number;
  9.     name: string;
  10.     subparts: Part[];
  11.     updatePart(newName: string): void;
  12. }
  14. type T40 = FunctionPropertyNames<Part>;  // "updatePart"
  15. type T41 = NonFunctionPropertyNames<Part>;  // "id" | "name" | "subparts"
  16. type T42 = FunctionProperties<Part>;  // { updatePart(newName: string): void }
  17. type T43 = NonFunctionProperties<Part>;  // { id: number, name: string, subparts: Part[] }

Similar to union and intersection types, conditional types are not permitted to reference themselves recursively.For example the following is an error.

Example

  1. type ElementType<T> = T extends any[] ? ElementType<T[number]> : T;  // Error

Type inference in conditional types

Within the extends clause of a conditional type, it is now possible to have infer declarations that introduce a type variable to be inferred.Such inferred type variables may be referenced in the true branch of the conditional type.It is possible to have multiple infer locations for the same type variable.

For example, the following extracts the return type of a function type:

  1. type ReturnType<T> = T extends (...args: any[]) => infer R ? R : any;

Conditional types can be nested to form a sequence of pattern matches that are evaluated in order:

  1. type Unpacked<T> =
  2.     T extends (infer U)[] ? U :
  3.     T extends (...args: any[]) => infer U ? U :
  4.     T extends Promise<infer U> ? U :
  5.     T;
  7. type T0 = Unpacked<string>;  // string
  8. type T1 = Unpacked<string[]>;  // string
  9. type T2 = Unpacked<() => string>;  // string
  10. type T3 = Unpacked<Promise<string>>;  // string
  11. type T4 = Unpacked<Promise<string>[]>;  // Promise<string>
  12. type T5 = Unpacked<Unpacked<Promise<string>[]>>;  // string

The following example demonstrates how multiple candidates for the same type variable in co-variant positions causes a union type to be inferred:

  1. type Foo<T> = T extends { a: infer U, b: infer U } ? U : never;
  2. type T10 = Foo<{ a: string, b: string }>;  // string
  3. type T11 = Foo<{ a: string, b: number }>;  // string | number

Likewise, multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred:

  1. type Bar<T> = T extends { a: (x: infer U) => void, b: (x: infer U) => void } ? U : never;
  2. type T20 = Bar<{ a: (x: string) => void, b: (x: string) => void }>;  // string
  3. type T21 = Bar<{ a: (x: string) => void, b: (x: number) => void }>;  // string & number

When inferring from a type with multiple call signatures (such as the type of an overloaded function), inferences are made from the last signature (which, presumably, is the most permissive catch-all case).It is not possible to perform overload resolution based on a list of argument types.

  1. declare function foo(x: string): number;
  2. declare function foo(x: number): string;
  3. declare function foo(x: string | number): string | number;
  4. type T30 = ReturnType<typeof foo>;  // string | number

It is not possible to use infer declarations in constraint clauses for regular type parameters:

  1. type ReturnType<T extends (...args: any[]) => infer R> = R;  // Error, not supported

However, much the same effect can be obtained by erasing the type variables in the constraint and instead specifying a conditional type:

  1. type AnyFunction = (...args: any[]) => any;
  2. type ReturnType<T extends AnyFunction> = T extends (...args: any[]) => infer R ? R : any;

Predefined conditional types

TypeScript 2.8 adds several predefined conditional types to lib.d.ts:

  • Exclude<T, U> – Exclude from T those types that are assignable to U.
  • Extract<T, U> – Extract from T those types that are assignable to U.
  • NonNullable<T> – Exclude null and undefined from T.
  • ReturnType<T> – Obtain the return type of a function type.
  • InstanceType<T> – Obtain the instance type of a constructor function type.

Example

  1. type T00 = Exclude<"a" | "b" | "c" | "d", "a" | "c" | "f">;  // "b" | "d"
  2. type T01 = Extract<"a" | "b" | "c" | "d", "a" | "c" | "f">;  // "a" | "c"
  4. type T02 = Exclude<string | number | (() => void), Function>;  // string | number
  5. type T03 = Extract<string | number | (() => void), Function>;  // () => void
  7. type T04 = NonNullable<string | number | undefined>;  // string | number
  8. type T05 = NonNullable<(() => string) | string[] | null | undefined>;  // (() => string) | string[]
  10. function f1(s: string) {
  11.     return { a: 1, b: s };
  12. }
  14. class C {
  15.     x = 0;
  16.     y = 0;
  17. }
  19. type T10 = ReturnType<() => string>;  // string
  20. type T11 = ReturnType<(s: string) => void>;  // void
  21. type T12 = ReturnType<(<T>() => T)>;  // {}
  22. type T13 = ReturnType<(<T extends U, U extends number[]>() => T)>;  // number[]
  23. type T14 = ReturnType<typeof f1>;  // { a: number, b: string }
  24. type T15 = ReturnType<any>;  // any
  25. type T16 = ReturnType<never>;  // never
  26. type T17 = ReturnType<string>;  // Error
  27. type T18 = ReturnType<Function>;  // Error
  29. type T20 = InstanceType<typeof C>;  // C
  30. type T21 = InstanceType<any>;  // any
  31. type T22 = InstanceType<never>;  // never
  32. type T23 = InstanceType<string>;  // Error
  33. type T24 = InstanceType<Function>;  // Error

Note: The Exclude type is a proper implementation of the Diff type suggested here. We’ve used the name Exclude to avoid breaking existing code that defines a Diff, plus we feel that name better conveys the semantics of the type.