api

Review TypeScript library API designs for developer experience.

888|82|Updated Aug 13, 2025
One-click install
npx skills add https://github.com/videojs/v10 --skill api-videojs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api
Source: https://github.com/videojs/v10/tree/main/.claude/skills/api
Command: npx skills add https://github.com/videojs/v10 --skill api-videojs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a structured framework for designing DX-focused TypeScript library APIs, helping teams build intuitive, safe, and composable interfaces.

Core Features & Use Cases

  • Emergent extensibility via well-designed core APIs
  • Composition over configuration to enable flexible, predictable APIs
  • Type inference-first patterns that maximize DX and minimize boilerplate
  • Review workflows to evaluate API surface, ergonomics, and architecture

Quick Start

Provide a TypeScript API proposal and request an expert DX review using the core principles and patterns described.

Frequently Asked Questions about api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design TypeScript APIs that feel obvious and intuitive?

To design obvious TypeScript APIs, enforce config-object patterns, inference-first typing, and explicit extension points. This approach minimizes boilerplate and ensures your library surfaces are fast, safe, and composable for developers.

What is the best way to evaluate developer experience for a library architecture?

Evaluating library architecture DX involves structured review workflows that critique API surfaces and ergonomics. You analyze whether the design supports emergent extensibility and composition over configuration to maximize developer experience.

How do I review a TypeScript API proposal for extensibility and safety?

Reviewing a TypeScript API proposal requires evaluating its core patterns against inference-first typing and explicit extension points. This structured critique identifies whether the interface enables predictable composition and maintains type safety.

Does composition over configuration work for TypeScript library design?

Yes, composition over configuration enables flexible and predictable TypeScript library APIs. By prioritizing composable surfaces and emergent extensibility, developers can build complex functionality without overwhelming boilerplate or rigid setups.

When should I use inference-first typing in API design?

Use inference-first typing in API design to maximize developer experience and minimize manual type boilerplate. It ensures library surfaces feel obvious and fast by automatically deriving types from config-object patterns and core implementations.