User-Defined Type Guards

A user-defined type guard is a function whose return type is a type predicate, letting callers narrow a value when the guard returns true.

What you will learn: the purpose of user-defined type guards, the rules TypeScript checks, and what its JavaScript behavior looks like in a runnable example.

Because a guard makes a claim to the type checker, its runtime checks must really prove that claim. A function named isUser that only tests truthiness is not sufficient to justify a complex user shape.

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.

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.

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 User = { name: string; age: number };
function isUser(value: unknown): value is User {
  if (typeof value !== "object" || value === null) return false;
  const item = value as Record<string, unknown>;
  return typeof item.name === "string" && typeof item.age === "number";
}
const data: unknown = { name: "Asha", age: 21 };
console.log(isUser(data));
if (isUser(data)) console.log(data.name.toUpperCase());

Verified output

true
ASHA

Run 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.

isUser rejects null and nonobjects, then checks both fields. The sample satisfies both tests, printing true. Inside the guard-controlled branch, TypeScript allows accessing name as string.

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.

A type predicate is not self-verifying; a poorly written guard can convince TypeScript of a false fact and cause runtime errors.

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.

Try isUser({name:"Asha",age:"21"}) and explain why it returns false.

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.

User-Defined Type Guards: A user-defined type guard is a function whose return type is a type predicate, letting callers narrow a value when the guard returns true.

isUser rejects null and nonobjects, then checks both fields. The sample satisfies both tests, printing true. Inside the guard-controlled branch, TypeScript allows accessing name as string.

Before continuing, explain one valid use case, one common pitfall, and the separation between compile-time checking and runtime behavior for this feature.