The keyof Constraint

A keyof constraint lets a generic function accept only known property names of a particular object type.

What you will learn: the purpose of the keyof constraint, the rules TypeScript checks, and what its JavaScript behavior looks like in a runnable example.

Typical syntax is K extends keyof T. Combining that with T[K] gives a return type tied to the selected key. keyof is checked statically, so runtime objects can still be incomplete or altered when data comes from unsafe sources.

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

function getProperty<T, K extends keyof T>(object: T, key: K): T[K] {
  return object[key];
}
const user = { name: "Mira", age: 24 };
console.log(getProperty(user, "name").toUpperCase());
console.log(getProperty(user, "age") + 1);

Verified output

MIRA
25

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.

TypeScript knows name selects a string and age selects a number. The first call prints MIRA; the second adds 1 to 24 and prints 25. A misspelled key is rejected for the known object type.

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.

Do not type key merely as string and claim the return is always valid; that loses the connection to actual keys.

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.

Add a boolean active property to user and retrieve all three properties through getProperty.

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.

The keyof Constraint: A keyof constraint lets a generic function accept only known property names of a particular object type.

TypeScript knows name selects a string and age selects a number. The first call prints MIRA; the second adds 1 to 24 and prints 25. A misspelled key is rejected for the known object type.

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