Ich habe durch Tests verifiziert, dass zwei Muster zum Importieren von Flussanmerkungen, Typen und Schnittstellen von einem npm-publizierten Modul möglich sind.

Im Folgenden verwende ich die folgenden Modulnamen:

• Modul A: definiert die Anmerkungen, Typen und Schnittstellen
• Modul B: verlässt sich auf Modul A und möchte eine Typ-Überprüfung dagegen durchführen und seine Anmerkungen, Typen und Schnittstellen verwenden.

Muster 1

Modul A

• Verwenden Sie die export type -Syntax für beide Typen und Schnittstellen:

  %Vor%

• Kopiere alle *.js Dateien als *.js.flow . Z.B. indem Sie in package.json Folgendes sehen:

  %Vor%
• Veröffentlichen Sie das Modul

Modul B

• deklariert einfach die Abhängigkeit mit npm i --S module-A macht die Anmerkungen auch verfügbar wegen der Dateien js.flow im Verzeichnis lib/ des veröffentlichten Moduls.

• Importieren Sie beide Typen und Schnittstellen mit der folgenden Syntax:

  %Vor%

Muster 2

Modul A

• Definieren Sie Typen, Interfaces und Module in einer declarations.js -Datei, die im Verzeichnis decl liegt (auf den Sie im Abschnitt [libs] von .flowconfig zeigen):

  %Vor%

• Sie müssen *.js -Dateien nicht als *.js.flow in das prepublish -Skript

kopieren
• Veröffentlichen Sie das Modul

Modul B

• deklariere die Abhängigkeit wie zuvor mit npm i --S module-A . Dieses Mal sind jedoch keine Anmerkungen, Typen und Schnittstellen verfügbar, da "Modul-A" keine *.js.flow -Dateien enthält, also ...
• Erhalte manuell die declarations.js -Datei aus dem "module-A" -Paket und lege sie in das decl -Verzeichnis (gezeigt vom [libs] -Abschnitt von .flowconfig
• Sie müssen keine Syntax verwenden, um Typen und Schnittstellen zu importieren; Sie werden automatisch verfügbar.

Die obigen zwei Muster sind die einzigen Methoden, die ich entdeckt habe, und haben nachgewiesen, dass sie funktionieren (obwohl ich keine umfassende Beschreibung finden konnte).

Meine Fragen sind:

1. Welches Muster ist idiomatischer / ratsam?
2. Gibt es ein anderes Muster?

Zu Frage # 1 kann ich sehen, dass "Muster 2" die einzig mögliche Methode ist, wenn "Modul-A" von einer anderen Organisation / Person veröffentlicht wird. Ansonsten, wenn man beide Module veröffentlicht, denke ich, "Muster 1" ist einfacher.