如何找到节点包的所有选项？

Question

这是关于节点模块的一般问题。每次我下载一个节点模块时，我都在网上争先恐后地提示我可以传递给节点模块的选项。在github上，似乎只有几个选项作为例子，但是如果我想看看有哪些其他选项可用以及它们做什么呢？我该怎么做呢？在命令提示符中有一种方法可以查看是否存在所有选项？ 例子......我怎么看这个选项...... https://www.npmjs.com/package/gulp-imagemin

Answer 1

每个节点模块（包）的文档在npm上可用，例如：

• https://www.npmjs.com/package/gulp-imagemin

默认显示的是项目中的README.md文件。有时它包含整个文档，有时它包含指向其他文档或网站的链接。

但有时它可能是空的或过时的，因为模块及其文档通常是由人们在空闲时间创建的，没有义务保持它或记录良好。

如果没有可用的文档或您认为文档不足，那么您可以发布问题（通常在GitHub上）或更新文档并发布拉取请求。

请参阅给定模块的文档，了解如何贡献或如何发布问题。在npm上，模块页面右侧应该有问题和拉取请求的链接。

Answer 2

我同意William关于节点模块的可用性。虽然大多数模块都有一些＆＃39; npmjs.com中的文档，以及＆＃39; some＆＃39;在模块的存储库中（如果是公共的，主要是github），没有表示功能的标准形式。此外，在许多情况下，文档并不全面。

理想情况下，我希望在npmjs.com中有一个标准模板，并带有以下详细信息。当部署在大型复杂的软件系统中时，这将有助于加快模块的消耗和可维护性。

1. 模块的高级描述。
2. 最常见的用例列表。
3. 其最常见（和期望的）拓扑列表
4. 公开的API列表，包括输入和预期输出，副作用，假设。
5. 调试潜在问题的提示。
6. 潜在的副作用（缓存，内存，开放fd＆＃39; s，剩余光盘文件，网络访问）

在我们与npm社区合作之前，人们可以添加/改进他们认为可以提高模块可用性的项目。