So far, the handbook has covered types which are atomic objects. However, as you model more types you find yourself looking for tools which let you compose or combine existing types instead of creating them from scratch.
Intersection and Union types are one of the ways in which you can compose types.
Union Types
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:
ts/** * Takes a string and adds "padding" to the left. * If 'padding' is a string, then 'padding' is appended to the left side. * If 'padding' is a number, then that number of spaces is added to the left side. */ function
TrypadLeft (value : string,padding : any) { if (typeofpadding === "number") { returnArray (padding + 1).join (" ") +value ; } if (typeofpadding === "string") { returnpadding +value ; } throw newError (`Expected string or number, got '${padding }'.`); }padLeft ("Hello world", 4); // returns " Hello world"
The problem with padLeft
in the above example 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.
ts// passes at compile time, fails at runtime. let
TryindentedString =padLeft ("Hello world", true);
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:
ts/** * Takes a string and adds "padding" to the left. * If 'padding' is a string, then 'padding' is appended to the left side. * If 'padding' is a number, then that number of spaces is added to the left side. */ function
TrypadLeft (value : string,padding : string | number) { // ... } letindentedString =padLeft ("Hello world",true ); Argument of type 'boolean' is not assignable to parameter of type 'string | number'.2345Argument of type 'boolean' is not assignable to parameter of type 'string | number'.
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
.
Unions with Common Fields
If we have a value that is a union type, we can only access members that are common to all types in the union.
tsinterface
TryBird {fly (): void;layEggs (): void; } interfaceFish {swim (): void;layEggs (): void; } declare functiongetSmallPet ():Fish |Bird ; letpet =getSmallPet ();pet .layEggs (); // Only available in one of the two possible typespet . Property 'swim' does not exist on type 'Bird | Fish'. Property 'swim' does not exist on type 'Bird'.2339Property 'swim' does not exist on type 'Bird | Fish'. Property 'swim' does not exist on type 'Bird'.swim ();
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.
Discriminating Unions
A common technique for working with unions is to have a single field which uses literal types which you can use to let TypeScript narrow down the possible current type. For example, we’re going to create a union of three types which have a single shared field.
tstype NetworkLoadingState = { state: "loading"; }; type NetworkFailedState = { state: "failed"; code: number; }; type NetworkSuccessState = { state: "success"; response: { title: string; duration: number; summary: string; }; }; // Create a type which represents only one of the above types // but you aren't sure which it is yet. type NetworkState = | NetworkLoadingState | NetworkFailedState | NetworkSuccessState;
All of the above types have a field named state
, and then they also have their own fields:
NetworkLoadingState |
NetworkFailedState |
NetworkSuccessState |
---|---|---|
state | state | state |
code | response |
Given the state
field is common in every type inside NetworkState
- it is safe for your code to access without an existence check.
With state
as a literal type, you can compare the value of state
to the equivalent string and TypeScript will know which type is currently being used.
NetworkLoadingState |
NetworkFailedState |
NetworkSuccessState |
---|---|---|
"loading" |
"failed" |
"success" |
In this case, you can use a switch
statement to narrow down which type is represented at runtime:
tstype
TryNetworkState = |NetworkLoadingState |NetworkFailedState |NetworkSuccessState ; functionnetworkStatus (state :NetworkState ): string { // Right now TypeScript does not know which of the three // potential types state could be. // Trying to access a property which isn't shared // across all types will raise an errorstate . Property 'code' does not exist on type 'NetworkState'. Property 'code' does not exist on type 'NetworkLoadingState'.2339Property 'code' does not exist on type 'NetworkState'. Property 'code' does not exist on type 'NetworkLoadingState'. // By switching on state, TypeScript can narrow the union // down in code flow analysis switch (code ;state .state ) { case "loading": return "Downloading..."; case "failed": // The type must be NetworkFailedState here, // so accessing the `code` field is safe return `Error ${state .code } downloading`; case "success": return `Downloaded ${state .response .title } - ${state .response .summary }`; } }
Intersection Types
Intersection types are closely related to union types, but they are used very differently.
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 type which is all of Person
and Serializable
and Loggable
.
That means an object of this type will have all members of all three types.
For example, if you had networking requests with consistent error handling then you could separate out the error handling into it’s own type which is merged with types which correspond to a single response type.
tsinterface
TryErrorHandling {success : boolean;error ?: {message : string }; } interfaceArtworksData {artworks : {title : string }[]; } interfaceArtistsData {artists : {name : string }[]; } // These interfaces are composed to have // consistent error handling, and their own data. typeArtworksResponse =ArtworksData &ErrorHandling ; typeArtistsResponse =ArtistsData &ErrorHandling ; consthandleArtistsResponse = (response :ArtistsResponse ) => { if (response .error ) {console .error (response .error .message ); return; }console .log (response .artists ); };