The in Operator for Narrowing
Understand The in Operator for Narrowing
The in operator checks whether a property exists on an object, and TypeScript can use that result to narrow a union.
What you will learn: the purpose of the in operator for narrowing, the rules TypeScript checks, and what its JavaScript behavior looks like in a runnable example.
What you’ll learn
- Explain how the in operator for narrowing works and where its type rules apply.
- Predict the exact output of the the in operator for narrowing example.
- Diagnose a common issue: Do not use "email" in contact when contact might be null or a primitive; the operator requires an object right-hand side.
Build the mental model
Test property membership only after you know a value is an object rather than null. The in operator checks inherited properties too, not just own properties. If a property is optional in multiple variants, its presence might not uniquely select one variant.
Key distinction: TypeScript checks the declared types during development; emitted JavaScript carries out the value-level operation at runtime. A type declaration alone never validates untrusted runtime input.
See the relationship
Read this illustration from the first labeled part to the last. Compare it with the example and identify which parts are type checks and which parts run in JavaScript.
Run the complete TypeScript example
This self-contained example uses fixed values, so it runs without reading input or depending on an external service. Paste it into the TypeScript Playground or save it as main.ts.
TypeScript program
type Email = { email: string };
type Phone = { phone: string };
function destination(contact: Email | Phone): string {
if ("email" in contact) return `Mail: ${contact.email}`;
return `Call: ${contact.phone}`;
}
console.log(destination({ email: "a@example.com" }));
console.log(destination({ phone: "1234" }));Verified output
Mail: a@example.com
Call: 1234Run locally: npx tsc --strict --target es2022 --module commonjs main.ts, then node main.js. For projects with a tsconfig.json, build using that configuration instead.
Trace every important step
The first object has an email property, so the email branch prints its address. The second lacks email, and its phone property is used instead.
Check each step: identify the input values, follow the JavaScript operation in execution order, and match the final expression with the exact output shown. An annotation can reject invalid source before execution, but does not change the value printed.
Avoid these common mistakes
Do not use "email" in contact when contact might be null or a primitive; the operator requires an object right-hand side.
How to debug: reproduce the issue in a minimal example. For compiler errors, inspect the inferred and declared types; for a runtime surprise, log the actual values and follow their references or branches.
Practice and experiment
Create a Dog | Cat union and narrow it using a property found on only one object type.
Practice routine: predict the result on paper, edit one part of the code, compile under --strict, run the JavaScript, and explain whether TypeScript caught an error or JavaScript simply behaved differently.
Check your understanding
Review the key idea
The in Operator for Narrowing: The in operator checks whether a property exists on an object, and TypeScript can use that result to narrow a union.
The first object has an email property, so the email branch prints its address. The second lacks email, and its phone property is used instead.
Before continuing, explain one valid use case, one common pitfall, and the separation between compile-time checking and runtime behavior for this feature.
Reaching the recap and completing the quizzes are separate milestones.