The Declaration Files section is designed to teach you how to write a high-quality TypeScript Declaration File. We need to assume basic familiarity with the TypeScript language in order to get started.
\nIf you haven’t already, you should read the TypeScript Handbook\nto familiarize yourself with basic concepts, especially types and modules.
\nThe most common case for learning how .d.ts files work is that you’re typing an npm package with no types.\nIn that case, you can jump straight to Modules .d.ts.
\nThe Declaration Files section is broken down into the following sections.
\nWe are often faced with writing a declaration file when we only have examples of the underlying library to guide us.\nThe Declaration Reference 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.
\nThe Library Structures guide helps you understand common library formats and how to write a proper 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 are strongly encouraged to read this section to properly understand how the format of the library influences the writing of the declaration file.
\nIn the Template section you’ll find a number of declaration files that serve as a useful starting point\nwhen writing a new file. If you already know what your structure is, see the d.ts Template section in the sidebar.
\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.
\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":"Declaration Reference","depth":2},{"value":"Library Structures","depth":2},{"value":"Do’s and Don’ts","depth":2},{"value":"Deep Dive","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","disable_toc":null,"oneline":"How to write a high-quality TypeScript Declaration (d.ts) file"}},"prev":null,"next":{"childMarkdownRemark":{"frontmatter":{"title":"Declaration Reference","oneline":"How to create a d.ts file for a module","permalink":"/docs/handbook/declaration-files/by-example.html"}}}},"pageContext":{"id":"introduction","slug":"/docs/handbook/declaration-files/introduction.html","repoPath":"/packages/documentation/copy/en/declaration-files/Introduction.md","nextID":"12e677cc-32d4-5d9a-b634-f8b46f88a62b","lang":"en","modifiedTime":"2020-08-07T17:00:36.335Z"}}}