《Node.js入门经典》一2.7 如何找模块文档

简介:

本节书摘来自异步社区《Node.js入门经典》一书中的第2章,第2.7节,作者【英】George Ornbo,更多章节内容可以访问云栖社区“异步社区”公众号查看

2.7 如何找模块文档

Node.js入门经典
在知道如何安装与寻找模块之后,我们还需要知道如何使用它们。通常来讲,Node.js模块都有编写良好的文档,可以通过运行如下命令在浏览器中查看模块文档:


5f485f8dc51dbe5552b612e371c041936cfdce89

这会打开浏览器并进入模块作者所提供的文档页面。这通常是一个指向 GitHub 上某个README文件的链接。要查看 underscore.js的文档,请运行:


8323f2498575f541e972c99c2b24c14fb9d649a7

通过运行如下命令也可以查看项目的bug:


a204e57390905bcebf8fe9cc2f64b23711ca406c

这会打开浏览器并进入模块作者所提供的问题页面。

随着读者越来越有经验,就会发现阅读模块的源代码是理解其作用的最快方法。


1ad033b0f12c08fc60ac306c745f960ea64a4c02

这里有个“意外”,那就是这个命令必须在Node.js项目文件夹的根目录下运行,而且该模块必须已经被下载到了node_modules文件夹中。


3dabaaa478379a9a8b0468a4b88ac473a526ac6b

大多数npm模块都托管在GitHub上,模块作者会对模块文档的贡献者极为感激。如果你在文档中发现了某些不足,可以考虑帮助作者改进文档。

相关文章
|
11天前
|
JavaScript 前端开发
Vue、ElementUI配合Node、multiparty模块实现图片上传并反显_小demo
如何使用Vue和Element UI配合Node.js及multiparty模块实现图片上传并反显的功能,包括前端的Element UI组件配置和后端的Node.js服务端代码实现。
14 1
Vue、ElementUI配合Node、multiparty模块实现图片上传并反显_小demo
|
2月前
|
JavaScript 数据可视化
JS如何优雅的实现模块自动滚动展示
【8月更文挑战第22天】JS如何优雅的实现模块自动滚动展示
20 1
JS如何优雅的实现模块自动滚动展示
|
24天前
|
JavaScript 前端开发 UED
让 HTML 向 Vue.js 华丽转身:如何把 `wangEditor` 仿腾讯文档项目整合进 Vue.js
让 HTML 向 Vue.js 华丽转身:如何把 `wangEditor` 仿腾讯文档项目整合进 Vue.js
|
26天前
Nest.js 实战 (十二):优雅地使用事件发布/订阅模块 Event Emitter
这篇文章介绍了在Nest.js构建应用时,如何通过事件/发布-订阅模式使应用程序更健壮、灵活、易于扩展,并简化服务间通信。文章主要围绕@nestjs/event-emitter模块展开,这是一个基于eventemitter2库的社区模块,提供了事件发布/订阅功能,使得实现事件驱动架构变得简单。文章还介绍了如何使用该模块,包括安装依赖、初始化模块、注册EventEmitterModule、使用装饰器简化监听等。最后总结,集成@nestjs/event-emitter模块可以提升应用程序的事件驱动能力,构建出更为松耦合、易扩展且高度灵活的系统架构,是构建现代、响应迅速且具有高度解耦特性的Nest.
|
1月前
|
缓存 JavaScript 前端开发
JavaScript模块化开发:ES6模块与CommonJs的对比与应用
JavaScript模块化开发:ES6模块与CommonJs的对比与应用
21 2
|
2月前
|
JavaScript 前端开发
js之DOM 文档对象模型
js之DOM 文档对象模型
17 1
js之DOM 文档对象模型
|
2月前
|
算法 JavaScript 前端开发
国标非对称加密:RSA算法、非对称特征、js还原、jsencrypt和rsa模块解析
国标非对称加密:RSA算法、非对称特征、js还原、jsencrypt和rsa模块解析
131 1
|
2月前
|
存储 缓存 JSON
Node.js有哪些模块系统
【8月更文挑战第12天】Node.js有哪些模块系统
35 3
|
2月前
|
算法 JavaScript 前端开发
对称加密算法解析:DES、AES及其在`pycryptodome` 和 `crypto-js` 模块中的应用
对称加密算法解析:DES、AES及其在`pycryptodome` 和 `crypto-js` 模块中的应用
106 1
|
2月前
[译] Node 模块中的 peer dependencies 是什么?
[译] Node 模块中的 peer dependencies 是什么?