npm 包 side-effects 使用教程

面试官:小伙子,你的数组去重方式惊艳到我了

什么是 side-effects

在开发前端应用时,无法避免使用第三方库。在引入第三方库时,往往需要在项目中处理它所引入的样式文件、JS 文件等资源。对于引入的一些库来说,可能因为它们会对全局环境产生影响而被称为非副作用模块。而一些模块会对全局环境产生一些看似无害的副作用,例如通过添加全局对象、修改原型链等操作。这些模块一般都是面向用户端的库,它们输出的不仅仅是 JavaScript 对象,还有一些全局代码。

这种“副作用”是在模块引入后,会对整个项目的代码产生影响,并不仅仅局限于当前模块中。因此,需要在项目中明确哪些模块带有副作用。

什么是 sideEffects

在 package.json 中,有一个 sideEffects 属性,它是一个 boolean 值或者一个数组。当它为 false 时,表明所有从这个包导入的模块都不带副作用。当 sideEffectstrue 或者数组时,则会被认为这个包或某些文件包含副作用的代码,并因此在打包时添加一些处理程序。

如何使用 sideEffects

首先,你需要了解你所依赖包的 sideEffects。你可以在它的 package.json 文件里找到这个属性。如果该属性未指定,那么需要直接通过它的文档或代码查找。

当找到了这个包的 sideEffects 再来判断当前项目是否允许它所包含的副作用代码。如果当前项目确实需要这个包中的副作用才能正常工作,你可以在你的项目的 package.json 文件里开启这个包的 sideEffects

-
  -------------- -
    -------------------
  --
  --------------- -
    --------- ----------
  -
-

以上代码的作用是允许 lodash 包的所有模块,并且允许当前项目中的样式文件引入样式带副作用。

如果你的项目禁止包含任何副作用的代码,那么你可以将 sideEffects 属性转换成一个布尔值,并将其赋值为 false

-
  -------------- ------
  --------------- -
    --------- ----------
  -
-

当然,在实际开发中,有些包依赖的代码中存在副作用和无副作用的代码混合的情况。此时我们需要使用一个数组来标识具有副作用的文件列表:

-
  -------------- -
    -------------------
    --------
    ---------
    ---------
    ---------
    ---------
    --------
    --------
    -------
  --
  --------------- -
    --------- ----------
  -
-

以上代码的作用是允许 lodash 包的所有模块,并且在项目中允许样式文件、图片文件带副作用。

示例代码

- -----
- ----- -------------------- -- -- -------------------- -- ---- ---- --

- -------
- ---- --- ------ -------
- ---- ------------------- - --------

- ---------- --- --------- --
- ---- ---------- -- ----------
- ---- ------- ---------- -- ----------

- -- ------------
- ---- --------- ----------------------- --------------- ---------- ----------- ---------- ---------- -------------- ----------- - ------------

- -----------
- ---- ------- --------

总结

在开发过程中,面对复杂的依赖关系,我们需要清楚地知道自己的项目是否能够承载某些依赖库带来的副作用。通过 sideEffects 属性,我们可以明确指定当前项目是否可以承载带有副作用的依赖库。当然,在实际开发中,同时需要根据依赖库的 package.json 文件的 sideEffects 字段来判断当前依赖库是否带有副作用代码,以及如何准确地指定具有副作用代码的资源或文件。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60056bec81e8991b448e5a8d


猜你喜欢

  • 如何在 Hapi 中使用 Socket.io 实现实时通信

    Socket.io 是一个基于 Node.js 的实时通信框架,可方便地实现服务端和客户端之间的实时通信。而 Hapi 是一个基于 Node.js 的 Web 开发框架,它提供了一些有用的工具和插件,...

    1 小时前
  • 在 ES9 中使用 obj.constructor() 函数创建对象

    在 JavaScript 中,我们通常使用对象字面量或构造函数来创建对象。但在 ES9 中,我们可以使用 obj.constructor() 函数来创建对象。这种方式可以让我们更加灵活地创建对象,并且...

    1 小时前
  • 如何使用 Mocha 测试 AngularJS 应用?

    Mocha 是一个流行的 JavaScript 测试框架,可针对多种应用程序和库进行测试。在前端开发领域中,测试是至关重要的一环,特别是对于 AngularJS 应用程序。

    1 小时前
  • Next.js 处理外部请求数据的方法和技巧

    Next.js 是一种流行的 React 框架,可以帮助我们构建可靠、可扩展的 Web 应用程序。与许多其他的 React 框架不同,Next.js 还提供了一些处理外部请求数据的方法和技巧,让应用程...

    2 小时前
  • 用 Fastify 实现自定义错误处理器

    Fastify 是一个基于 Node.js 的快速和低开销 Web 框架。它专为构建高效和可伸缩的服务而设计,提供了很多强大的功能,如内置的插件系统、路由、中间件等等。

    2 小时前
  • Kubernetes 中的 Job 和 CronJob 使用详解

    Kubernetes 是一个用于管理容器化应用程序的开源平台,它有助于在大规模分布式系统中轻松部署、管理和扩展应用。在 Kubernetes 中,Job 和 CronJob 是用于执行批处理任务和定期...

    2 小时前
  • 在 Hapi.js 中实现推送通知

    推送通知是现代 Web 应用程序的重要组成部分,使得您可以向用户传递实时信息,而无需用户每次主动获取。在这篇文章中,我们将探讨如何在 Hapi.js 中实现推送通知,以便更好地服务我们的用户。

    2 小时前
  • 用 Redis 响应快速的 GraphQL 查询

    GraphQL 是一种用于 API 的查询语言,可以让前端开发人员灵活地请求数据并减少不必要的网络请求。然而,在大型应用程序中,GraphQL 查询可以变得相当复杂和缓慢,尤其是在处理大量数据时。

    3 小时前
  • JavaScript 面向对象编程:ECMAScript 2021 中的类

    在 JavaScript 中,面向对象编程(OOP)是一种常见的编程范型。在 ECMAScript 2021 中,类被引入作为一种更加强大且方便的面向对象编程方式。

    3 小时前
  • Chai 报错:expected [] to have length 1 解决方法

    前言 在前端开发中,测试是非常重要的一部分。而 Chai 是一款常用的 JavaScript 测试库,它提供了许多有用的断言和 API,可以帮助我们进行测试驱动开发(TDD)和行为驱动开发(BDD)。

    3 小时前
  • Serverless 如何实现热启动?

    随着云计算技术的发展,Serverless 架构已经成为了一种越来越受欢迎的应用架构模式,它可以为开发者提供更快的部署、更低的成本和更好的可伸缩性。但是,Serverless 架构中的函数冷启动问题一...

    3 小时前
  • Redis 的应用场景与优缺点分析

    在前端开发中,缓存是一个非常有用的工具,它可以提高网站的响应速度以及数据传输的效率。而 Redis 作为一款常用的缓存服务器,可以应用在很多场景下。本文将介绍 Redis 的应用场景及其优缺点分析,旨...

    4 小时前
  • 如何在 React 中使用 WebSocket 进行实时通信

    WebSocket 是一种提供实时双向通信的协议,与传统的 HTTP 协议不同,它可以在客户端和服务器之间建立持久连接,使得服务器可以主动向客户端推送消息。React 作为一种流行的开发框架,为了实现...

    4 小时前
  • ECMAScript 2017 中的字符串填充方法:String.padStart() 和 String.padEnd()

    在 JavaScript 中,字符串操作一直是前端开发中最基础也最常用的功能之一,ECMAScript 2017 标准中新增的字符串填充方法 String.padStart() 和 String.pa...

    4 小时前
  • 以 Flex 布局构建响应式设计分割视图

    在当今网络应用程序生态系统中,设计响应式界面非常重要。这种技术允许用户适应不同设备和浏览器屏幕,并使应用程序对于各种设备尺寸都具有良好的适应性。因此,在开发前端应用程序时,设计响应式视图是必不可少的。

    4 小时前
  • 如何在 Angular 应用中实现单元测试

    如何在 Angular 应用中实现单元测试 单元测试在软件工程中是非常重要的一部分,它可以提高代码质量和可维护性。对于 Angular 应用来说,单元测试同样也是不可或缺的。

    4 小时前
  • 多方共建,让北京市无障碍发展健康前行

    多方共建,让北京市无障碍发展健康前行 随着互联网技术的迅猛发展,人们的交流和信息获取方式愈加多样化,但同时,我们也看到了无障碍互联网的重要性。 无障碍网站是指在设计、开发和使用时,考虑了所有人的需求,...

    4 小时前
  • Sequelize(ORM)基础

    在开发现代 Web 应用时,数据存储是不可或缺的一部分。一般而言,应用需要连接数据库来存储和检索信息。但是,直接连接数据库并进行数据操作通常是困难的,因为大部分关系数据库(如 SQLite,Postg...

    5 小时前
  • Deno 应用中如何处理 XML 格式数据

    引言 Deno 是一个新兴的 JavaScript 运行时环境,它与 Node.js 类似,但具有许多 Node.js 中缺失的特性,例如 TypeScript 的原生支持、安全的模块加载等等。

    5 小时前
  • React 中的内联样式和外部样式表的区别

    React 是一种广泛使用的 JavaScript 库,用于开发用户界面。React 支持一种特殊的语法,称为 JSX,它使得将 HTML 和 JavaScript 混合使用变得更加简单和直观。

    5 小时前