npm 包 denormalize-json-api 使用教程

什么是 denormalize-json-api

denormalize-json-api 是一个 JavaScript 包,它可以把 JSON API 返回的数据进行去标准化,也就是把所有涉及关系的数据都展开成一个平面的对象。

安装

使用 denormalize-json-api 很简单,只需要在命令行输入以下命令:

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

使用方法

denormalize-json-api 的使用非常简单,只需要在你的代码中引入它:

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

基本用法

denormalizeJsonApi 函数接收两个参数: denormalizedData 和 options。其中, denormalizedData 是 JSON API 返回的原始数据, options 是一个对象,用于配置去标准化时的行为。

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

上面的代码中,我们使用 denormalizeJsonApi 函数对 denormalizedData 进行去标准化,并把结果赋值给 normalizedData 变量。运行代码,你会发现 normalizedData 包含了所有的数据,并且都展开成了一个平面的对象。输出结果如下:

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

从上面的输出结果中可以看出, denormalizeJsonApi 函数成功把原始数据展开成了一个平面的对象,并使用 entity type 和 entity id 作为对象的属性名。

配置选项

options 对象有以下几个可配置属性:

  • idAttribute: 指定 JSON API 返回的数据中表示 id 的属性名,默认为 id
  • typeAttribute: 指定 JSON API 返回的数据中表示实体类型的属性名,默认为 type
  • included: 指定是否展开included字段中的数据,默认为 true。

示例代码:

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

运行上面的代码,输出结果如下:

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

从输出结果可以看出, denormalizeJsonApi 函数成功地使用了我们指定的属性名来展开数据。

应用场景

denormalize-json-api 适用于需要对 JSON API 的返回结果进行二次处理的情况。比如,你需要在前端展示一个列表,包含了每篇文章所属的用户信息。JSON API 返回的数据中,文章和用户之间的关系是通过 relationship 字段表示的。使用 denormalize-json-api 可以把所有涉及关系的数据都展开成一个平面的对象,这样在前端渲染数据时就更加方便了。

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


猜你喜欢

  • npm 包 closest-link 使用教程

    最近在前端开发中使用了一个叫 closest-link 的 npm 包,这个包可以帮助我们查找最接近的链接元素。本文将介绍 closest-link 包的安装、使用以及使用示例,并且希望能够对前端开发...

    2 年前
  • npm 包 hydoc 使用教程

    在前端开发中,文档的编写和维护是一个很重要的工作,它直接影响到项目的开发和维护效率。而 hydoc 是一个可以简化文档编写的 npm 包,它提供了一种基于注释的方式来生成文档的方法。

    2 年前
  • npm 包 readme-builder 使用教程

    简介 npm 是一个非常常用的 JavaScript 包管理工具,通过很多 npm 包可以方便快捷的集成一些常用的功能,并且这些包都已经被测试好了,所以我们无需自己去编写这些模块,直接调用即可使用。

    2 年前
  • npm 包 vsl-nearley 使用教程

    简介 vsl-nearley 是一个在 JavaScript 程序中使用 Nearley 语法分析器的包,支持用户自定义的语法生成器,以及文法脚本的在线编辑和测试。

    2 年前
  • npm 包 generator-webpackrxjs 使用教程

    简介 generator-webpackrxjs 是一个基于 Yeoman 的 npm 包,用于快速搭建基于 webpack 和 RxJS 的前端项目。通过使用该包,您可以轻松构建一个具有基础功能的前...

    2 年前
  • npm 包 @syasliya/fson 使用教程

    什么是 @syasliya/fson @syasliya/fson 是一个轻量级的 JavaScript 库,它可以让前端开发者更加容易地处理和操作 JSON 格式的数据,提供了一些常用的操作方法和工...

    2 年前
  • npm 包 egg-ws 使用教程

    在前端开发中,WebSocket 多用于实现即时通讯、实时数据更新等功能。而 egg-ws 就是一个基于 Egg.js 的 WebSocket 插件,使得在 Egg.js 后端应用中实现 WebSoc...

    2 年前
  • npm 包 stemcstudio-json 使用教程

    在前端开发过程中,经常需要处理 JSON 数据。如果没有一个好用的工具包,会让处理 JSON 数据变得非常麻烦。 stemcstudio-json 是一个基于 JavaScript 的 npm 包,提...

    2 年前
  • npm 包 mesos-operator-api-client 使用教程

    前言 Mesos 是一个开源的分布式系统内核,可用于管理大规模的集群资源。而 Mesos Operator API 是 Mesos 的一项 RESTful API,可以方便地操作 Mesos 集群资源...

    2 年前
  • npm 包 lesscloud-app-builder 使用教程

    随着 Web 2.0 的普及以及移动互联网的迅猛发展,前端技术变得越来越重要。为了提高前端团队的开发效率以及保证代码的质量和可维护性,很多前端开发人员开始采用 npm 包来管理自己的项目。

    2 年前
  • npm 包 Vueplus-UI 使用教程

    在开发前端应用过程中,使用现成的 UI 组件库可以大大提升开发效率,让前端开发者更专注于业务逻辑的实现。Vueplus-UI 就是一个基于 Vue.js 的 UI 组件库,通过 npm 包的形式提供给...

    2 年前
  • npm 包 nodebb-plugin-books2 使用教程

    介绍 NodeBB 是一款非常流行的开源论坛软件,它可以扩展使用各种插件来实现不同的功能。而这篇文章将介绍一个名为 nodebb-plugin-books2 的 npm 包,它可以为 NodeBB 论...

    2 年前
  • npm 包 es6-promise-semaphore 使用教程

    前言 在前端开发中,我们经常会遇到需要等待异步操作的场景,比如等待多个 Promise 都完成后再做后续处理。es6-promise-semaphore 是一个用于 Promise 限流的 npm 包...

    2 年前
  • npm 包 confettize 使用教程

    在前端开发中,往往需要使用一些效果来增强用户体验。而其中一个非常简单且实用的效果就是撒花效果。而这时候我们可以使用 npm 包 confettize 来实现撒花效果。

    2 年前
  • npm 包 gnat-schema-loader 使用教程

    在前端开发中,我们经常需要处理数据的格式化和校验。为了减少重复编写代码,我们可以使用现成的 npm 包。其中一个常用的包就是 gnat-schema-loader,它可以让我们方便地通过 JSON S...

    2 年前
  • npm 包 `graphql-redis-subscriptions-async-iterator` 使用教程

    简介 graphql-redis-subscriptions-async-iterator 是一个基于 Redis 的 GraphQL 实时订阅库。通过使用该库,您可以方便地实现 GraphQL 的实...

    2 年前
  • npm 包 bitskins 使用教程

    什么是 bitskins? bitskins 是一款基于 Node.js 的开源 npm 包,提供了对 BitSkins 网站的 API 接口的封装,方便 Node.js 开发者进行交易平台开发。

    2 年前
  • npm 包 git-tidy 使用教程

    在团队协作中,代码版本管理是非常重要的一环。Git 作为目前最流行的版本控制系统之一,被众多开发者所运用。但在开发过程中,难免会出现代码冲突、分支混乱等问题。这时候,一个好用的 Git 工具就显得尤为...

    2 年前
  • npm包tempfile-2的使用教程

    在前端开发中,我们经常需要使用临时文件来存储一些临时数据,例如上传文件等。而npm包tempfile-2可以帮助我们方便地创建临时文件,本文将介绍tempfile-2的使用方法。

    2 年前
  • npm 包 codemirror-github-light 使用教程

    什么是 codemirror-github-light? codemirror-github-light 是一个用于构建单页应用程序的开源文本编辑器。它提供了一整套算法和工具,可以让开发者构建高度可定...

    2 年前

相关推荐

    暂无文章