La sección de Archivos de Declaración está diseñada para enseñarte cómo escribir un archivo de Declaración TypeScript de alta calidad. Necesitamos asumir familiaridad básica con el lenguaje TypeScript para poder empezar.
Si aún no lo has hecho, deberías leer el Manual de TypeScript para familiarizarte con los conceptos básicos, especialmente los tipos y módulos.
El caso más común para aprender cómo funcionan los archivos .d.ts es que estás tipando un paquete npm sin tipos. En ese caso, puedes saltar directamente a Módulos .d.ts.
La sección de Archivos de Declaración se divide en las siguientes secciones.
Referencia de Declaración
A menudo nos enfrentamos a escribir un archivo de declaración cuando solo tenemos ejemplos de la biblioteca subyacente para guiarnos. La sección Referencia de Declaración muestra muchos patrones comunes de API y cómo escribir declaraciones para cada uno de ellos. Esta guía está dirigida al principiante de TypeScript que puede que aún no esté familiarizado con todas las construcciones del lenguaje en TypeScript.
Estructuras de Bibliotecas
La guía Estructuras de Bibliotecas te ayuda a comprender los formatos comunes de bibliotecas y cómo escribir un archivo de declaración adecuado para cada formato. Si estás editando un archivo existente, probablemente no necesites leer esta sección. Se recomienda encarecidamente a los autores de nuevos archivos de declaración que lean esta sección para comprender adecuadamente cómo el formato de la biblioteca influye en la escritura del archivo de declaración.
En la sección Plantilla encontrarás una serie de archivos de declaración que sirven como un punto de partida útil al escribir un archivo nuevo. Si ya sabes cuál es tu estructura, consulta la sección Plantilla d.ts en la barra lateral.
Qué Hacer y Qué No Hacer
Muchos errores comunes en los archivos de declaración se pueden evitar fácilmente. La sección Qué Hacer y Qué No Hacer identifica errores comunes, describe cómo detectarlos y cómo solucionarlos. Todos deberían leer esta sección para ayudarse a evitar errores comunes.
Análisis Profundo
Para autores experimentados interesados en la mecánica subyacente de cómo funcionan los archivos de declaración, la sección Análisis Profundo explica muchos conceptos avanzados en la escritura de declaraciones, y muestra cómo aprovechar estos conceptos para crear archivos de declaración más limpios e intuitivos.
Publicar en npm
La sección Publicación explica cómo publicar tus archivos de declaración en un paquete npm y muestra cómo gestionar tus paquetes dependientes.
Encontrar e Instalar Archivos de Declaración
Para los usuarios de bibliotecas JavaScript, la sección Consumo ofrece unos sencillos pasos para localizar e instalar los archivos de declaración correspondientes.
