Index Signatures
This lesson covers dynamic string or number keys on objects. You will see how the concept fits into everyday TypeScript and why it matters for reliable applications.
Index Signatures Overview
Index Signatures is a core part of the TypeScript type system. Understanding it helps you model data accurately, catch mistakes early, and communicate intent to teammates through types.
We focus on practical patterns you will use in real codebases—not abstract theory. Examples mirror common frontend, backend, and library scenarios.
| Topic | Pattern | Why it matters |
| Core idea | dynamic string or number keys on objects | Foundation for typed code |
| Syntax | [key: string]: number | Common pattern in real projects |
| Compiler | Checked at build time | Errors caught before deploy |
| Runtime | Erased to JavaScript | No type overhead in production |
| Tooling | IDE autocomplete | Faster refactors and reviews |
Index Signatures Example
interface Scores {
[player: string]: number;
}
const board: Scores = { alice: 10, bob: 8 };
board.charlie = 5;
Index signatures type dictionaries with open key sets.
When to Use Index Signatures
- Modeling data that requires index signatures
- Reviewing or refactoring typed application code
- Building reusable libraries with clear contracts
- Onboarding developers to a TypeScript codebase
- Preparing for interviews on TypeScript fundamentals
- Pairing types with tests for critical business logic
Best Practices
- Use index signatures to document intent at API boundaries
- Prefer inference for local variables when types are obvious
- Enable strict compiler options to maximize checking
- Name types clearly with domain language, not abbreviations
- Combine with narrowing when working with union types
- Review compiler errors instead of silencing with any
- Keep examples small and composable in production code
Common Mistakes to Avoid
- Over-annotating when inference already suffices
- Using type assertions instead of proper narrowing
- Applying patterns without understanding runtime behavior
- Ignoring null and undefined in strict mode
- Duplicating types instead of reusing aliases or interfaces
- Expecting types to validate external JSON automatically
- Mixing incompatible module settings with bundler output
Key Takeaways
- Index Signatures strengthens contracts in TypeScript code
- Types are erased at compile time—validate external data separately
- Combine with interfaces, unions, and generics as needed
- Strict mode surfaces more issues during development
- Good naming makes complex types self-documenting
- Next: explore TypeScript Functions to continue the course
Pro Tip
When learning index signatures, recreate the example in the TypeScript Playground and break it on purpose to read compiler errors—they teach the rules quickly.