@aws-sdk/客户端-codeguru-审查器

说明

JavaScript CodeGuruReviewer客户端的AWS SDK为节点.js,浏览器和React Independent的客户端.

本节提供亚马逊代码Guru审查器API操作的文档. 代码Guru审查器是一个 使用程序分析和机器学习来检测潜在缺陷的服务 在您的 Java 和 Python 中, 开发者很难找到并推荐修正 代码.

通过主动发现代码缺陷并提出建议 执行最佳做法,《守则》审查员提高整体质量和维持能力 代码检讨阶段的代码基础。 关于CodeGuru审查器的更多信息,请参见: 亚马逊代码Guru审查器用户指南。 。 。 .

为了提高代码Guru审查员API电话的安全性,您可以建立私人连接 您的 VPC 和 CodeGuru 评审器之间通过创建 接口 VPC 端点用于 更多信息,见 代码Guru审查器和界面 VPC 终点( Amazon Web Services PrivateLink) 输入 亚马逊代码Guru审查器用户 指南。 。 。 .

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

• npm install @aws-sdk/client-codeguru-reviewer
• yarn add @aws-sdk/client-codeguru-reviewer
• pnpm add @aws-sdk/client-codeguru-reviewer

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 CodeGuruReviewerClient 财务报告和审定财务报表 例如,您需要的命令 ListCodeReviewsCommand数字 :

// ES5 example
const { CodeGuruReviewerClient, ListCodeReviewsCommand } = require("@aws-sdk/client-codeguru-reviewer");

// ES6+ example
import { CodeGuruReviewerClient, ListCodeReviewsCommand } from "@aws-sdk/client-codeguru-reviewer";

使用量

发出请求:

• 以配置(如证书,区域)为客户端提供证据.
  • 见 文件/中心 用于配置细节.
  • 见 @aws- sdk/ 配置 附加选项.
• 以输入参数证明命令 .
• 打电话 send 操作客户端,以输入方式提供命令对象.

const client = new CodeGuruReviewerClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListCodeReviewsCommand(params);

自动/等待

我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

承诺

您还可以使用 承诺连锁。 。 。 .

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

合并客户端

归集客户端类别从同套件中导出,但没有"Client"后缀.

CodeGuruReviewer 扩展 CodeGuruReviewerClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(CodeGuruReviewerClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { CodeGuruReviewer } from "@aws-sdk/client-codeguru-reviewer";

const client = new CodeGuruReviewer({ region: "REGION" });

// async/await.
try {
  const data = await client.listCodeReviews(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listCodeReviews(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listCodeReviews(params, (err, data) => {
  // process err and data.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

另见 文档/错误。 。 。 .

获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

• 访问 开发者指南 或者说 API 参考。 。 。 .
• 看看贴有标签的博客文章 aws-sdk-js aWS 开发者博客.
• 问个问题 叠叠流 并贴上标签 aws-sdk-js。 。 。 .
• 加入 AWS JavaScript 社区 发光。 。 。 .
• 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-codeguru-reviewer 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)