Skip to main content
TYPESCRIPT-BASICS5 MIN READ

Quick ref: module API hygiene

Recall how exported TypeScript types, TSDoc comments, and SemVer fit together for public module APIs.

battlecard comparison card flashcard deck Objection "Let's export all helper types so consumers have options." A package is used by multiple apps and follows versioned releases. Your line Exporting a helper invites consumers to depend on it. Let's export the stable contract and keep construction details private. More exports feel generous but create more public API to support. It applies SemVer's public API discipline to TypeScript exports. Compare Internal helper type vs public contract type If consumers should not rely on it, do not export it casually. Recall What does TSDoc help standardize? Think exported symbols. Structured documentation comments for…

Read the full lesson

Sign up free — one personalized lesson every day, matched to your role and goals.

Already have an account? Sign in

← Back to library
Contact us