npm 包 @build-tracker/api-client 使用教程

简介

@build-tracker/api-client 是一个针对 @build-tracker/server 提供的基于 RESTful API 的前端监控工具。利用此工具，您可以轻松地获取前端构建数据、报告构建消耗的时间，以及在多个构建之间进行比较等。

安装

要安装此 npm 包，您需要运行以下命令：

npm install @build-tracker/api-client --save

或者，如果您使用 yarn，可以运行以下命令：

yarn add @build-tracker/api-client

使用

使用 @build-tracker/api-client 时，您需要首先创建一个 ApiClient 实例，并在构造函数中提供一些参数，如下所示：

import { ApiClient } from '@build-tracker/api-client';

const client = new ApiClient({
  baseUrl: 'https://your-build-tracker-url.com',
  apiKey: 'your-api-key-here'
});

在这里，您需要提供您的 Build Tracker 服务器的 baseUrl 和 apiKey。如果 API 服务器是公共的，apiKey 可以为空。但是如果您需要保护您的数据，您应该使用一个有效的 API 密钥。

获取构建报告

您可以使用 ApiClient 的 getBuildReport 方法来获取特定构建的报告，如下所示：

const report = await client.getBuildReport({
  projectId: 'your-project-id',
  revision: 'your-revision-hash'
});

console.log(report);

在这里，您需要提供项目 ID 和提交哈希值。

该方法的返回值为一个包含构建报告的对象。这个对象包括构建的日期、持续时间、资源大小、构建时的错误以及包含所有资源的数组等等信息。

获取构建列表

如果您需要获取所有构建的列表，您可以使用 ApiClient 的 getBuildList 方法，如下所示：

const builds = await client.getBuildList({
  projectId: 'your-project-id',
  limit: 100,
  offset: 0
});

console.log(builds);

这个方法也需要提供项目 ID，limit 和 offset 参数分别用于限制返回数目以及返回偏移量。

该方法的返回值包含一个构建列表，每个构建对象包括构建的日期、提交哈希、资源大小等等信息。

获取资源列表

如果您需要获取在构建期间使用的资源列表，您可以使用 ApiClient 的 getResourceList 方法，如下所示：

const resources = await client.getResourceList({
  projectId: 'your-project-id'
});

console.log(resources);

此方法只需要项目 ID 参数，并且将返回一个包含所有资源的数组。每个资源对象包括资源的名称、类型、大小、哈希等信息。

获取构建之间的差异

如果您需要比较不同构建之间的差异，您可以使用 ApiClient 的 diff 方法，如下所示：

const diff = await client.diff({
  projectId: 'your-project-id',
  from: 'initial-commit-hash',
  to: 'latest-commit-hash'
});

console.log(diff);

此方法将返回两个构建之间的差异报告，报告包括旧构建和新构建之间的新增、删除和更改的文件列表，以及每个文件的大小和哈希等信息。

结论

在本文中，我们介绍了如何安装和使用 @build-tracker/api-client 包来获取和分析 Build Tracker 返回的数据。使用这个包，您可以轻松地获得构建的报告、资源大小、持续时间等信息，并比较不同构建之间的差异。我们希望这篇文章对您有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f0dc16d403f2923b035c1b7