Why does the skill recommend against function overloads?

Function overloads often result in poor error messages and confusing autocomplete for the end-user; the skill suggests using configuration objects or distinct names to improve clarity and type safety.

Can I use this skill to review existing codebases?

Yes, it includes specialized review workflows and checklists designed to audit existing architectures for DX flaws, consistency, and adherence to modern TypeScript best practices.

What makes an API 'ergonomic' according to this skill?

An ergonomic API minimizes cognitive load, offers sensible defaults, provides predictable outcomes, and leverages TypeScript's engine so that types flow naturally without requiring excessive manual annotations.

How does this skill help with library extensibility?

It promotes 'emergent extensibility' which favors well-designed core APIs over rigid plugin systems, using patterns like composition, pipelines, and the onion model for middleware.

TypeScript API Design & DX

Name: TypeScript API Design & DX
Author: videojs

byvideojs

•

151

•

API開発

Architects and reviews developer-centric TypeScript APIs using industry-standard design principles and ergonomic patterns.

This skill provides a comprehensive framework for designing and auditing TypeScript library APIs with a focus on developer experience (DX). It implements advanced architectural patterns such as the 'onion model' for middleware, progressive disclosure of complexity, and robust type inference strategies. Whether you are building an open-source framework or an internal utility, this skill helps ensure your APIs are composable, type-safe, and intuitive by identifying anti-patterns like boolean traps and positional parameter confusion.