api-design

Design and validate public APIs for TypeScript, JavaScript, React, and React Native libraries.

3|Updated Jan 7, 2026
One-click install
npx skills add https://github.com/jonluca/palate --skill api-design-jonluca
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/jonluca/palate/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/jonluca/palate --skill api-design-jonluca

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of designing clear, maintainable APIs that serve developers by reducing cognitive load, simplifying integration, and ensuring compatibility across platforms.

Core Features & Use Cases

  • API Design Guidelines: Offers a comprehensive set of rules and best practices for API design.
  • Public API Shape: Focuses on the surface-level contract for libraries, including function signatures, type definitions, and error handling.
  • Use Case: When building a library or module in TypeScript, JavaScript, React, or React Native, this Skill ensures your API adheres to established best practices and design patterns.

Quick Start

Design the public API for your library using this skill's guidelines, then validate it against the provided rules.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a public API for a TypeScript library?

Design a public API for a TypeScript library by defining clear type definitions, function signatures, and error handling rules. This ensures your API surface maintains consistency, reduces cognitive load, and simplifies integration for developers using your module.

What are the best practices for React Native API surface design?

React Native API surface design best practices focus on the user experience of developers integrating your library. You should validate function signatures and type definitions against established design patterns to ensure maintainability and cross-platform compatibility.

When do I need to validate my JavaScript library's public API?

You need to validate your JavaScript library's public API when building a module to ensure it adheres to established design patterns. This validation process checks the surface-level contract, including error handling and function signatures, to simplify integration.

Does this approach to API design work for both React and React Native?

Yes, this API design approach works for both React and React Native. It designs and validates public APIs specifically for these frameworks, ensuring the library's surface-level contract maintains consistency and ease of integration across platforms.

How do I reduce cognitive load for developers integrating my TypeScript API?

Reduce cognitive load for developers integrating your TypeScript API by applying strict API design guidelines. This involves crafting predictable function signatures and type definitions that create a clear, maintainable surface-level contract for your library.