将流定义添加到打字稿库

Question

我编写了一个名为redux-async-action-reducer 的库。我已经用打字稿写了它。我想向它添加流定义。

有什么方法可以将它与我的库一起保存，而不是创建一个单独的并将其放入flow-typed？

类似 d.ts 的流定义文件？

Answer 1

您可以在您的包入口点旁边提供一个 .js.flow 文件的库。在您的情况下（由于您的包入口点是 dist/index.js，您将在 dist/index.js.flow 创建一个文件。

Flow 会将其视为普通的源文件。您必须记住将// @flow 放在顶部。您可以编写带有存根实现的函数和类，也可以使用declare（例如declare export function foo(x: string): string;，与类类似）。

请注意，这实际上与库定义文件不同——Flow 会将其视为源代码。

流类型是分发 libdef 的首选方式。当 Flow 在版本之间进行重大更改时，使用 .js.flow 文件可能会导致问题。但是，由于您将分发一个手工策划的界面，而不是将整个库源作为 .js.flow 文件发送，因此该问题将得到缓解。