Introdução

A seção Arquivos de declaração é designada a ensinar você como escrever um Arquivo de Declaração TypeScript de alta qualidade. Precisamos assumir uma familiaridade básica com a linguagem TypeScript para começar.

Caso ainda não tenha feito, você deveria ler o Manual do TypeScript

O caso mais comum para aprender como os arquivos .d.ts funcionam é quando você está escrevendo um pacote npm sem tipos. Nesse caso, você pode ir direto para Módulos .d.ts.

A seção Arquivos de declaração é dividida nas seguintes partes:

Referência de Declaração

Nós geralmente enfrentamos a tarefa de escrever um arquivo de declaração somente quando temos exemplos da biblioteca subjacente para nos orientar. A seção Referência de declaração mostra vários padrões comuns de API e como escrever declarações para cada um deles. Este guia é voltado aos iniciantes em TypeScript que talvez não estejam ainda familiarizados com todas as construções de linguagem em TypeScript.

Estruturas da Biblioteca

O guia Estruturas da Biblioteca ajuda você a entender formatos comuns de biblioteca e como escrever um arquivo de declaração apropriado para cada formato. Se você está editando um arquivo existente, você provavelmente não precisa ler esta seção. Autores de novos arquivos de declaração recomendam fortemente a leitura desta seção para entender propriamente como o formato da biblioteca influencia a escrita do arquivo de declaração.

Na seção Template você encontrará vários arquivos de declaração que servem como um ponto de partida útil quando se está escrevendo um novo arquivo. Se você já conhece a sua estrutura, veja a seção Template d.ts na barra lateral.

O que fazer e o que Não fazer

Muitos erros comuns em arquivos de declaração podem ser facilmente evitados. A seção O que fazer e o que Não fazer identifica erros comuns, descreve como detectá-los, e como corrigi-los. Todos devem ler esta seção para evitar erros comuns.

Análise profunda

Para autores experientes interessados na mecânica por trás dos arquivos de declaração, a seção Análise profunda explica vários conceitos avançados na escrita da declaração, e mostra como aproveitar esses conceitos para criar arquivos de declaração limpos e mais intuitivos.

Publicar no npm

A seção Publicação explica como publicar seus arquivos de declaração em um pacote npm, e como gerenciar seus pacotes dependentes.

Buscar e instalar Arquivos de Declaração

Para usuário de bibliotecas Javascript, a seção Consumo oferece alguns passos para localizar e instalar arquivos de declaração correspondentes.

The TypeScript docs are an open source project. Help us improve these pages by sending a Pull Request

Contributors to this page:
MHMohamed Hegazy  (61)
  (6)
CRCrhistian Ramirez  (1)
VRValera Rozuvan  (1)
JFJeremy Foster  (1)
6+

Last updated: 24 de jun. de 2022