Advanced (Sub)Types in TypeScript You Need to Know
Nandani Sharma
Posted on August 16, 2024
Introduction
I’ve long appreciated the basic types and interfaces that TypeScript offers. They provide invaluable type safety and code clarity.
Consider a common User type:
interface User {
id: number;
name: string;
email: string;
phone: number;
}
Now, imagine these common use cases:
- Displaying a public profile without phone and ID
- Handling a user form submission without an ID
- Updating only the user’s name
Initially, you might think you need to define separate types for each scenario, raising concerns about code reusability. But fear not!
TypeScript provides a powerful set of advanced types that can elevate your TypeScript skills and solve these challenges elegantly.
In this post, we’ll explore some of TypeScript’s most useful advanced types: Pick
, Partial
, Omit
, and others.
These utilities allow you to write more concise, flexible, and safer code. They're surprisingly easy to grasp and incredibly helpful when working with databases, API responses, or form submissions.
1. Pick
Creating a Subset of Properties
Pick creates a new type by selecting a set of properties K
from the type T
. It allows you to create a subset of an existing type.
When you need to work with only specific properties of a larger type, especially in API responses or form submissions you can use Pick.
Considering the above example, we can create two different types using the Pick from User
as below.
type UserInfo = Pick<User, 'id' | 'name'>
type UserBasicInfo = Pick<User, 'name' | 'email'>
const user: UserInfo = {
id: 1,
name: "abc",
}
const userDetails: UserBasicInfo = {
name: "abc",
email: "abc@gmail.com",
}
2. Partial
Making All Properties Optional
Partial creates a new type with all properties of T
set to optional.
When you want to update an object but don’t need to provide all properties, you can use Partial type. It is often used in PATCH API endpoints.
type PartialUser = Partial<User>
const user: PartialUser = {
name: "abc",
}
3. Required
Making All Properties Required
Required creates a new type with all properties of T
set to required, removing optional modifiers.
You can use Required, when you need to ensure all properties of an object are provided, often used in configuration objects or form submissions.
type FormUser = Required<User>
const user: FormUser = {
id: 1,
name: "abc",
email: "abc@gmail.com",
phone: 9999999999,
}
4. Readonly
Creating Immutable Types
Readonly creates a new type with all properties of T
set to readonly.
When you want to create immutable data structures or prevent accidental modifications like database configuration, you can use Readonly .
Consider a DB configuration object:
interface DBConfig {
host?: string;
port?: number;
username?: string;
password?: string;
database?: string;
}
class DatabaseConnector {
connect(config: Readonly<AppConfig>) {
console.log('Connecting to database with config:', config);
}
}
5. Record
Creating an Object Type with Specific Key-Value Pairs
Record creates an object type whose property keys are K
and values are T
.
When you need to create a dictionary or map-like structure with specific key and value types like for adding roles and permission as below, Record will help you to simplify the structure.
type Role = 'admin' | 'user' | 'guest';
type Permissions = 'read' | 'write' | 'delete';
type RolePermissions = Record<Role, Permissions[]>;
const permissionMap: RolePermissions =
{
admin: ['read', 'write', 'delete'],
user: ['read', 'write'],
guest: ['read']
}
6. Omit
Excluding Specific Properties
When you want to create a new type by excluding certain properties from an existing type, you can use Omit.
Omit creates a new type with all properties from T
except those specified in K
.
Considering you don’t want to show phone on the user’s profile, You can create a new type using Omit as below,
type ProfileUser = Omit<User, 'phone'>;
const user: ProfileUser = {
id: 1,
name: "abc",
email: "abc@gmail.com",
}
7. Exclude
Excluding specific members from union types
It is useful when the type is Union Type. Exclude creates a type by excluding from T
all union members that are assigned to U
.
When you want to remove specific types from a union type you can use Exclude.
For example,
type AllowedTypes = string | number | boolean | null | undefined;
// remove null and undefined
type NonNullableTypes = Exclude<AllowedTypes, null | undefined>;
function processValue(value: NonNullableTypes) {
console.log(`Processing value of type ${typeof value}:`, value);
}
processValue('Hello');
processValue(42);
processValue(true);
// Below would cause compile-time errors:
processValue(null);
processValue(undefined);
8. Extract
Extracting specific members from union types
Extract creates a type by extracting from T
all union members that are assignable to U
. It is the reverse of Exclude where you can ignore a given type.
Consider a scenario where you have a mix of data types and want to extract only the numeric types:
type MixedData = string | number | boolean | Date | { [key: string]: any };
type NumericData = Extract<MixedData, number>;
function processNumericData(data: NumericData) {
console.log(`Processing numeric data: ${data}`);
}
processNumericData(42);
// Below would cause compile-time errors:
processNumericData('42');
processNumericData(true);
processNumericData(new Date());
processNumericData({});
9. NonNullable
Excluding null and undefined
NonNullable creates a type by excluding null and undefined from T
.
You can use NonNullable when you want to ensure that a value is neither null
nor undefined
. It is often used in form validation or data processing.-
type UserInput = string | number | null | undefined;
function processUserInput(input: NonNullable<UserInput>) {
console.log(`Processing user input: ${input}`);
}
processUserInput('Hello');
processUserInput(42);
// Below would cause compile-time errors:
processUserInput(null);
processUserInput(undefined);
To read the full version, please visit canopas blog.
Conclusion
If you like what you read, be sure to hit 💖 button! — as a writer it means the world!
I encourage you to share your thoughts in the comments section below or reach us at Canopas Twitter handle @canopas_eng with your content or feedback.
Your input not only enriches our content but also fuels our motivation to create more valuable and informative articles for you.
Happy coding! 👋
Posted on August 16, 2024
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.
Related
February 18, 2023