脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → node.js → Node.js封装实用函数的npm包

Node.js如何优雅的封装一个实用函数的npm包的方法

 更新时间：2019年04月29日 10:12:08   作者：萧萧fe  
这篇文章主要介绍了Node.js如何优雅的封装一个实用函数的npm包的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

为什么要封装一个实用函数的 npm 包?

当你连续写了多个 Node 应用, 都想要 console 漂亮一点, 你可能会像下面这样封装一个函数

import chalk from "chalk";

function noop(msg: string): string {
  return msg
}

function log(fn: Function): (msg: string) => void {
  return (msg: string): void => {
    console.log(fn(msg));
  };
}

export default {
  success: log(chalk.green),
  error: log(chalk.red),
  warn: log(chalk.yellow),
  info: log(chalk.cyan),
  log: log(noop)
};

调用方式

import log from './log'
log.success("hello green message!")
log.error("hello red message!")
log.warn("hello yellow message!")
log.info("hello cyan message!")
log.log("hello normal message!")

慢慢的发现每个项目都需要这么一个 log 文件, 是的! 我们此时可以考虑把这些常用的函数封装集合到一个 npm 包里面了!

需要注意的事项有哪些

单元测试

考虑到代码量的增加以及贡献者的增加事先加入单元测试是很有必要的

  • 测试框架 - Mocha 是一个功能丰富的Javascript测试框架，它能运行在Node.js和浏览器中，支持BDD、TDD、QUnit、Exports式的测试
  • 断言库 - assert 是 Node 自带的

持续集成

Travis CI 提供的是持续集成服务（Continuous Integration，简称 CI）。它绑定 Github 上面的项目，只要有新的代码，就会自动抓取。然后，提供一个运行环境，执行测试，完成构建，还能部署到服务器。

代码层面

扩展开放, 修改关闭的设计原则

当 src 目录新增一个实用函数文件, index.ts 能够自动抓取然后挂载在 module.export 上

通过 getter 巧妙的实现懒加载导出的功能

Object.defineProperty(module.export, 'log', {
  configurable: false,
  enumerable: true,
  get: () => require('./log')
});

项目地址

https://github.com/xiaoxiaojx/enhanced 欢迎 🌟 Star 🌟 和 Pr  和 在项目中使用～

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • 使用Raygun对Node.js应用进行错误处理的方法

    使用Raygun对Node.js应用进行错误处理的方法

    这篇文章主要介绍了使用Raygun对Node.js应用进行错误处理的方法,Node.js是一款用于服务器端的JavaScript框架,需要的朋友可以参考下
    2015-06-06
  • Node.js 源码阅读深入理解cjs模块系统

    Node.js 源码阅读深入理解cjs模块系统

    这篇文章主要为大家介绍了Node.js 源码阅读深入理解cjs模块系统，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-09-09
  • electron demo项目npm install安装失败的解决方法

    electron demo项目npm install安装失败的解决方法

    下面小编就为大家分享一篇electron demo项目npm install安装失败的解决方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2018-02-02
  • NodeJs项目中关闭ESLint的方法

    NodeJs项目中关闭ESLint的方法

    ESLint是一个用来识别 ECMAScript 并且按照规则给出报告的代码检测工具，使用它可以避免低级错误和统一代码的风格。这篇文章主要介绍了NodeJs项目中关闭ESLint的方法,需要的朋友可以参考下
    2018-08-08
  • Node.js 使用命令行工具检查更新

    Node.js 使用命令行工具检查更新

    这篇文章主要介绍了Node.js 使用命令行工具检查更新的方法，使用Node.js开发命令行工具是开发者应该掌握的一项技能，适当编写命令行工具以提高开发效率，有需要的小伙伴可以参考下
    2017-06-06
  • Node.js中使用jQuery的做法

    Node.js中使用jQuery的做法

    在Node.js中使用jQuery的做法，需要先安装jquery，npm install jquery ,安装后的版本是 3.1.0,本文介绍的非常详细，具有参考借鉴价值，感兴趣的朋友一起看下吧
    2016-08-08
  • 浅谈Node 调试工具入门教程

    浅谈Node 调试工具入门教程

    这篇文章主要介绍了浅谈Node 调试工具入门教程，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • node.js + socket.io 实现点对点随机匹配聊天

    node.js + socket.io 实现点对点随机匹配聊天

    这篇文章主要介绍了node.js + socket.io 实现点对点随机匹配聊天，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-06-06
  • 抛弃Nginx使用nodejs做反向代理服务器

    抛弃Nginx使用nodejs做反向代理服务器

    每当提起反向代理器，人们通常一想到的就是 Nginx，但是今天我们暂时忽略大名鼎鼎的 Nginx，采用同样也是使用单线程、事件循环的服务端小弟——Nodejs 来达成。
    2014-07-07
  • 可能是全网最详细的nodejs卸载和安装教程

    可能是全网最详细的nodejs卸载和安装教程

    npm的中文意思为"node包管理器",是Node.js平台的默认包管理工具,会随着Nodejs一起安装,npm管理对应node.js的第三方插件,下面这篇文章主要给大家介绍了关于nodejs卸载和安装教程的相关资料，这可能全网最详细的教程了,需要的朋友可以参考下
    2023-05-05

最新评论