instalar - typescript example

Tipificaciones de TypeScript en paquetes de organización npm @types

Question

Me di cuenta de que hay una organización @types , que contiene paquetes de mecanografía, pero no puedo encontrar ninguna documentación al respecto. ¿Cómo están destinados a ser utilizados?

¿Está destinado a ser utilizado con la herramienta de typings ? Si es así, ¿cómo instalarlos? Por ejemplo, hay un paquete @types/openlayers , pero los typings search npm:openlayers no devuelve nada.

¿Está destinado a ser utilizado por separado de la herramienta de tipificación? Por ejemplo, instalado directamente con npm ?

Answer 1

A partir de TypeScript 2.0, las tipificaciones ya no son necesarias. La organización npm es una entidad para configurar un equipo de desarrolladores. Creo que Microsoft configuró la organización @types en npm y agregó el equipo de desarrolladores de TypeScript a la organización. Los paquetes en la organización @types se publican automáticamente desde DefinitelyTyped utilizando la herramienta de publicación de tipos según los docs .

Además, hay otra forma de agregar types a sus paquetes:

En tu package.json

Si su paquete tiene un archivo .js principal, también deberá indicar el archivo de declaración principal en su archivo package.json . Establezca la propiedad de types para que apunte a su archivo de declaración incluido. Por ejemplo:

{
    "name": "awesome",
    "author": "Vandelay Industries",
    "version": "1.0.0",
    "main": "./lib/main.js",
    "types": "./lib/main.d.ts"
}

Tenga en cuenta que el campo "typings" es sinónimo de "types" , y podría usarse también.

También tenga en cuenta que si su archivo de declaración principal se llama index.d.ts y vive en la raíz del paquete (junto a index.js ), no necesita marcar la propiedad "types" , aunque es recomendable hacerlo.

En cuanto a los tipos de búsqueda

En su mayor parte, los paquetes de declaración de tipo siempre deben tener el mismo nombre que el nombre del paquete en npm, pero con el prefijo @ types /, pero si lo necesita, puede consultar https://aka.ms/types para encontrar el paquete para tu biblioteca favorita

De: http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html

Pero cuando hice npm search @types/openlayers , no obtuve ningún resultado. Pero hacer la búsqueda desde la interfaz web me devolvió los resultados. Así que supongo que la npm search no busca entre organizaciones.

Answer 2

El anuncio en el blog de TypeScript responde a esto: El futuro de los archivos de declaración

Resumen:

La organización @types npm es para obtener definiciones de tipo con npm . El uso de estas definiciones de tipo es una característica que viene en TypeScript 2.0.

Esto reemplazará los proyectos / herramientas actuales, tales como typings y tsd , aunque estos continuarán siendo compatibles durante algún tiempo.

Answer 3

Esta será una característica que se implementa en Typecript 2.0. Esto proporciona soporte de tipo para módulos / bibliotecas UMD y sus respectivas definiciones.

Consulte ( https://github.com/Microsoft/TypeScript/issues/7125#issuecomment-210182488 ) para obtener una mejor comprensión de los problemas actuales con las tipificaciones ambientales.