b2b-web-type-conventions

Use TypeScript interfaces for defining API response models and object data shapes, while using type aliases for unions, intersections, and simple primitive compositions. This distinction ensures consistent type naming and structural conventions across your codebase.

Enforce consistent TypeScript type usage by applying standardized interface and type rules during code creation and review. This guides frontend teams to follow unified naming conventions and structural definitions, reducing type errors across the codebase.

The best way to define API response models in React TypeScript is using interfaces to map directly to the data structure. Reserve type aliases for simple unions or intersections to maintain clear structural conventions.

Identify type naming violations during code review by checking interface versus type usage against established rules. This skill highlights inconsistencies in type definitions and provides actionable modification directions to fix structural errors.

This interface and type convention guide primarily targets frontend teams using React and TypeScript. While the core interface versus type usage rules apply to any TypeScript project, the implementation focus is tailored for React environments.

Inconsistent TypeScript type errors often occur when teams lack unified rules for interface versus type usage. Implementing standardized naming conventions and structural checks during type definition creation resolves these inconsistencies.