This guide is designed to teach you how to write a high-quality TypeScript Declaration File.
\nIn this guide, we’ll assume basic familiarity with the TypeScript language.\nIf you haven’t already, you should read the TypeScript Handbook\nto familiarize yourself with basic concepts, especially types and namespaces.
\nThe guide is broken down into the following sections.
\nThe Library Structures guide helps you understand common library formats and how to write a correct declaration file for each format.\nIf you’re editing an existing file, you probably don’t need to read this section.\nAuthors of new declaration files must read this section to properly understand how the format of the library influences the writing of the declaration file.
\nMany times, we are faced with writing a declaration file when we only have examples of the underlying library to guide us.\nThe By Example section shows many common API patterns and how to write declarations for each of them.\nThis guide is aimed at the TypeScript novice who may not yet be familiar with every language construct in TypeScript.
\nMany common mistakes in declaration files can be easily avoided.\nThe Do’s and Don’ts section identifies common errors,\ndescribes how to detect them,\nand how to fix them.\nEveryone should read this section to help themselves avoid common mistakes.
\nFor seasoned authors interested in the underlying mechanics of how declaration files work,\nthe Deep Dive section explains many advanced concepts in declaration writing,\nand shows how to leverage these concepts to create cleaner and more intuitive declaration files.
\nIn Templates you’ll find a number of declaration files that serve as a useful starting point\nwhen writing a new file.\nRefer to the documentation in Library Structures to figure out which template file to use.
\nThe Publishing section explains how to publish your declaration files to an npm package, and shows how to manage your dependent packages.
\nFor JavaScript library users, the Consumption section offers a few simple steps to locate and install corresponding declaration files.
","headings":[{"value":"Sections","depth":1},{"value":"Library Structures","depth":2},{"value":"By Example","depth":2},{"value":"“Do”s and “Don’t”s","depth":2},{"value":"Deep Dive","depth":2},{"value":"Templates","depth":2},{"value":"Publish to npm","depth":2},{"value":"Find and Install Declaration Files","depth":2}],"frontmatter":{"permalink":"/docs/handbook/declaration-files/introduction.html","title":"Introduction"}}},"pageContext":{"slug":"/docs/handbook/declaration-files/introduction.html","isOldHandbook":true}}}