DefinitelyTyped vs index.d.ts für Winkel Bibliothek

Question

ich eine einfache Bibliothek mit Unit-Tests Helfer für Winkel 1.x erstellt: https://github.com/dakolech/angular-unit-testing-helpers

Und nun möchte ich Typen Definitionen hinzuzufügen. Meine Frage ist: Sollte ich index.d.ts Datei in meinem Repository erstellen oder soll ich w neue Ordner in DefinitelyTyped Repository erstellen?

Wenn zuerst, dann, wie Winkeltypen in diesen Dateien (z. B. ng.IScope) importieren?

Answer 1

Der bevorzugte Ansatz ist, wenn möglich, die Typen in Ihr NPM-Paket aufzunehmen und deren Position in Ihrer package.json anzugeben.

Sie müssen die [etwas] .d.ts-Datei in Ihr Projekt einfügen, eine "typings" -Eigenschaft zu Ihrer referenzierenden package.json hinzufügen und diese und Ihren Code in NPM veröffentlichen.

Die offizielle Dokumentation hierzu finden Sie unter https://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html.

Wenn Ihr Projekt von Typen abhängt, die in ihren NPM-Paketen keine Typen enthalten, wird dies komplizierter. Weitere Informationen finden Sie unter https://github.com/typings/typings/blob/master/docs/faq.md#should-i-use-the-typings-field-in-packagejson. Sie möchten eine typings.json-Datei einfügen, die angibt, wie Sie Ihre Abhängigkeiten mit Typings erhalten, und dann Ihren Benutzern mitteilen, dass sie typings install npm:your-page ausführen sollen, was ihnen sowohl Ihre Typdefinitionen als auch alle abhängigen Definitionen von typings.json gibt.