Type Casting Expressions

Asserting and casting values to different types

Sometimes it is useful to assert a type without using something like a function or a variable to do so. For this Flow supports an inline type cast expression syntax which can be used in a number of different ways.

Type Cast Expression Syntax

In order to create a type cast expression around a value, add a colon : with the Type and wrap the expression with parentheses ( ).

1
 
(value: Type)

Note: The parentheses are necessary to avoid ambiguity with other syntax.

Type cast expressions can appear anywhere an expression can appear.

1
2
3
 
let val = (value: Type);
let obj = { prop: (value: Type) };
let arr = ([(value: Type), (value: Type)]: Array<Type>);

The value itself can also be an expression:

1
 
(2 + 2: number);

When you strip the types all that is left is the value.

1
 
(value: Type);

1
 
value;

Type Assertions

Using type cast expressions you can assert that values are certain types.

1
2
3
4
5
6
 
// @flow
let value = 42;

(value: 42);     // Works!
(value: number); // Works!
(value: string); // Error!
Cannot cast `value` to string because number [1] is incompatible with string [2].

Asserting types in this way works the same as types do anywhere else.

Type Casting

When you write a type cast expression, the result of that expression is the value with the provided type. If you hold onto the resulting value, it will have the new type.

1
2
3
4
5
6
7
8
9
10
11
 
// @flow
let value = 42;

(value: 42);     // Works!
(value: number); // Works!

let newValue = (value: number);

// $ExpectError
(newValue: 42);     // Error!
(newValue: number); // Works!
Cannot cast `newValue` to number literal `42` because number [1] is incompatible with number literal `42` [2].

Using type cast expressions

Note: We’re going to go through a stripped down example for demonstrating how to make use of type cast expressions. This example is not solved well in practice.

Type Casting through any

Because type casts work the same as all other type annotations, you can only cast values to less specific types. You cannot change the type or make it something more specific.

But you can use any to cast to whatever type you want.

1
2
3
4
5
6
7
8
9
10
11
 
let value = 42;

(value: number); // Works!
// $ExpectError
(value: string); // Error!

let newValue = ((value: any): string);

// $ExpectError
(newValue: number); // Error!
(newValue: string); // Works!

By casting the value to any, you can then cast to whatever you want.

This is unsafe and not recommended. But it’s sometimes useful when you are doing something with a value which is very difficult or impossible to type and want to make sure that the result has the desired type.

For example, the following function for cloning an object.

1
2
3
4
5
6
7
8
9
 
function cloneObject(obj) {
  const clone = {};

  Object.keys(obj).forEach(key => {
    clone[key] = obj[key];
  });

  return clone;
}

It would be hard to create a type for this because we’re creating a new object based on another object.

If we cast through any, we can return a type which is more useful.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
// @flow
function cloneObject(obj) {
  const clone = {};

  Object.keys(obj).forEach(key => {
    clone[key] = obj[key];
  });

  return ((clone: any): typeof obj); // <<
}

const clone = cloneObject({
  foo: 1,
  bar: true,
  baz: 'three'
});

(clone.foo: 1);       // Works!
(clone.bar: true);    // Works!
(clone.baz: 'three'); // Works!

Type checking through type assertions

If we want to validate what kinds of types are coming into our cloneObject method from before, we could write the following annotation:

1
2
3
 
function cloneObject(obj: { [key: string]: mixed }) {
  // ...
}

But now we have a problem. Our typeof obj annotation also gets this new annotation which defeats the entire purpose.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
// @flow
function cloneObject(obj: { [key: string]: mixed }) {
  const clone = {};
  // ...
  return ((clone: any): typeof obj);
}

const clone = cloneObject({
  foo: 1,
  bar: true,
  baz: 'three'
});

// $ExpectError
(clone.foo: 1);       // Error!
// $ExpectError
(clone.bar: true);    // Error!
// $ExpectError
(clone.baz: 'three'); // Error!
Cannot cast `clone.foo` to number literal `1` because mixed [1] is incompatible with number literal `1` [2]. Cannot cast `clone.bar` to boolean literal `true` because mixed [1] is incompatible with boolean literal `true` [2]. Cannot cast `clone.baz` to string literal `three` because mixed [1] is incompatible with string literal `three` [2].

Instead we can assert the type within the function using a type assertion and now we’re validating our inputs.

1
2
3
4
5
6
7
8
9
 
// @flow
function cloneObject(obj) {
  (obj: { [key: string]: mixed });
  // ...
}

cloneObject({ foo: 1 }); // Works!
// $ExpectError
cloneObject([1, 2, 3]);  // Error!
Cannot cast `obj` to object type because array literal [1] is incompatible with object type [2].

Now type inference can keep working for typeof obj which returns the expected shape of the object.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
// @flow
function cloneObject(obj) {
  (obj: { [key: string]: mixed }); // <<

  const clone = {};
  // ...
  return ((clone: any): typeof obj);
}

const clone = cloneObject({
  foo: 1,
  bar: true,
  baz: 'three'
});

(clone.foo: 1);       // Works!
(clone.bar: true);    // Works!
(clone.baz: 'three'); // Works!

Note: This is not the proper solution to the above problem, it was being used for demonstration only. The correct solution is annotating the function like this:

1
2
3
 
function cloneObject<T: { [key: string]: mixed }>(obj: T): $Shape<T> {
 // ...
}
← Typeof Types Utility Types →

Was this guide helpful? Let us know by sending a message to @flowtype.