Typeof Types
Flow's typeof type operator extracts the Flow type of a value, so you can use it as a type annotation.
let size = 42; let other: typeof size = 100; // type is number
When to use this
Use typeof to derive a type from an existing value rather than writing it manually. This is useful when a module exports a value but not its type, or when you want to keep annotations in sync with a variable's inferred type. If the type is already available as a named export, prefer importing it directly.
typeof type syntax
The typeof operator returns the Flow type of a given value to be used as a type.
let num1 = 42; let num2: typeof num1 = 3.14; // Works! let num3: typeof num1 = 'world'; // Error! let bool1 = true; let bool2: typeof bool1 = false; // Works! let bool3: typeof bool1 = 42; // Error! let str1 = 'hello'; let str2: typeof str1 = 'world'; // Works! let str3: typeof str1 = false; // Error!
You can use any value with typeof, as long as the argument itself is a variable or member access:
let obj1 = {foo: 1, bar: true, baz: 'three'};
let obj2: typeof obj1 = {foo: 42, bar: false, baz: 'hello'};
let num: typeof obj1.foo = 1;
let arr1 = [1, 2, 3];
let arr2: typeof arr1 = [3, 2, 1];
type T = typeof {a: 1}; // Error
typeof inherits behaviors of inference
When you use typeof, you're taking the results of Flow's inference and asserting it as a type. While this can be very useful, it can also lead to some unexpected results.
For example, when you use literal values in Flow, their inferred type is the primitive that it belongs to. Thus, the number 42 has the inferred type of number. You can see this when you use typeof.
let num1 = 42; let num2: typeof num1 = 3.14; // Works! let bool1 = true; let bool2: typeof bool1 = false; // Works! let str1 = 'hello'; let str2: typeof str1 = 'world'; // Works!
However, this only happens with the inferred type. If you specify the literal type, it will be used in typeof.
let num1: 42 = 42; let num2: typeof num1 = 3.14; // Error! let bool1: true = true; let bool2: typeof bool1 = false; // Error! let str1: 'hello' = 'hello'; let str2: typeof str1 = 'world'; // Error!
typeof inherits behaviors of other types
There are many different types in Flow, some of these types behave differently than others. These differences make sense for that particular type but not for others.
When you use typeof, you're inserting another type with all of its behaviors. This can make typeof seem inconsistent where it is not.
For example, if you use typeof with a class you need to remember that classes are nominally typed instead of structurally typed. So that two classes with the same exact shape are not considered equivalent.
class MyClass {
method(val: number) { /* ... */ }
}
class YourClass {
method(val: number) { /* ... */ }
}
let test1: typeof MyClass = YourClass; // Error!
let test2: typeof MyClass = MyClass; // Works! Differences from runtime typeof
JavaScript's runtime typeof operator returns a string like "number" or "object", but it can't distinguish many types — for example, objects, arrays, and null all produce "object":
typeof {foo: true} === 'object';
typeof [true, false] === 'object';
typeof null === 'object'; Flow's typeof is a type-level operator that gives you the full Flow type of a value, preserving its exact structure. It is not used at runtime — it only exists in type annotations.
See Also
-
Classes —
typeofis commonly used with classes to refer to the class value (not instance) type -
Modules —
typeofimports for getting the type of an imported value -
Nominal & Structural Typing —
typeofwith classes preserves nominal typing behavior
© 2013–present Facebook Inc.
Licensed under the MIT License.
https://flow.org/en/docs/types/typeof