# @forgerock/crest-js 中文文档

规范地址：https://npmcn.com/package/%40forgerock/crest-js/

版本：2\.1\.11
npm 元数据更新时间：2026-07-14T16:33:28.476Z
中文译文更新时间：2026-11-15T07:46:22.222Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40forgerock/crest-js
原文对照：https://npmcn.com/package/%40forgerock/crest-js/?lang=original
项目主页：https://forgerock.github.io/crest-js
源码仓库：https://github.com/ForgeRock/crest-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：445 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2018-11-13T23:13:00.065Z
- 最新版本发布：2022-04-12T10:40:54.943Z
- 近 30 天下载量：8399（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

与 ForgeRock CREST APIS 通信的轻量级库.

## 安装

```sh
npm install @forgerock/crest-js
```

也可以使用：`pnpm add @forgerock/crest-js`、`yarn add @forgerock/crest-js`、`bun add @forgerock/crest-js`

## README

![](https://npmcn.com/package/%40forgerock/crest-js/logo.png)

# (原始内容存档于2018-03-26). ForgeRock CREST.js

与 ForgeRock CREST APIS 通信的轻量级库.

 [![](https://img.shields.io/npm/v/@forgerock/crest-js.svg?style=flat-square)](https://www.npmjs.com/package/@forgerock/crest-js)![](https://img.shields.io/david/forgerock/crest-js.svg?style=flat-square)

-   [先决条件](https://npmcn.com/package/%40forgerock/crest-js/#readme-prerequisites)
-   [支持的版本](https://npmcn.com/package/%40forgerock/crest-js/#readme-supported-versions)
-   [安装](https://npmcn.com/package/%40forgerock/crest-js/#readme-installation)
    -   [通过 Yarn](https://npmcn.com/package/%40forgerock/crest-js/#readme-via-yarn)
    -   [通过国家预防机制](https://npmcn.com/package/%40forgerock/crest-js/#readme-via-npm)
-   [使用量](https://npmcn.com/package/%40forgerock/crest-js/#readme-usage)
    -   [基础](https://npmcn.com/package/%40forgerock/crest-js/#readme-basic)
    -   [支助方法](https://npmcn.com/package/%40forgerock/crest-js/#readme-supported-methods)
    -   [选项](https://npmcn.com/package/%40forgerock/crest-js/#readme-options)
        -   [`queryString`](https://npmcn.com/package/%40forgerock/crest-js/#readme-querystring)
    -   [中间软件](https://npmcn.com/package/%40forgerock/crest-js/#readme-middleware)
-   [发展](https://npmcn.com/package/%40forgerock/crest-js/#readme-development)
    -   [项目结构](https://npmcn.com/package/%40forgerock/crest-js/#readme-project-structure)
    -   [大楼](https://npmcn.com/package/%40forgerock/crest-js/#readme-building)
    -   [文档](https://npmcn.com/package/%40forgerock/crest-js/#readme-docs)
    -   [测试](https://npmcn.com/package/%40forgerock/crest-js/#readme-testing)
    -   [测试范围](https://npmcn.com/package/%40forgerock/crest-js/#readme-test-coverage)
-   [捐款](https://npmcn.com/package/%40forgerock/crest-js/#readme-contributing)
-   [进一步阅读](https://npmcn.com/package/%40forgerock/crest-js/#readme-further-reading)

## 先决条件

ForgeRock CREST.js 要求将 [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) 财务报告和审定财务报表 [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) 可在全球环境中获取的API.

## 支持的版本

ForgeRock CREST.js支持CREST版本2.0和2.1.

```js
import { CRESTv2, CRESTv2_1 } from "@forgerock/crest-js";
```

## 安装

### 通过 Yarn

```sh
yarn add @forgerock/crest-js
```

### 通过国家预防机制

```sh
npm install @forgerock/crest-js
```

## 使用量

### 基础

```js
import { CRESTv2 } from "@forgerock/crest-js";

const resource = new CRESTv2("http://www.domain.com/crest/api");

resource.get("id").then(json => {
  // Success! `json` is an Object
}, error => {
  if (error instanceof CRESTError) {
    // CREST error
  } else if (error instanceof RequestError) {
    // Request could not be completed e.g. network failure
  } else if (error instanceof ParseError) {
    // Response couldn't be parsed as JSON
  }
});
```

CREST 资源返回时的所有功能.

承诺允许在核心功能之上容易地建立起来,例如,与一贯处理拒绝问题的普通处理者打交道.

### 支助方法

```js
import { CRESTv2_1 } from "@forgerock/crest-js";

const resource = new CRESTv2_1("http://www.domain.com/crest/api");
const body = { data: "value" };

// #action
resource.action("action");
resource.action("action", { body }); // Action with body

// #create
resource.create(body); // Server provided ID
resource.create(body, { id: "id" }); // Client provided ID

// #delete
resource.delete("id");

// #get
resource.get("id");

// #queryFilter
resource.queryFilter(); // Only supports `_queryFilter=true`

// #update
resource.update("id", body);
```

目前只通过额外的查询字符串选项支持 Pgination `queryString`。 。 。 .

见 [API 文档](https://forgerock.github.io/crest-js) 所有可能的选择.

### 选项

#### `queryString`

在任何请求中添加额外查询字符串 .

```js
import { CRESTv2 } from "@forgerock/crest-js";

const resource = new CRESTv2("http://www.domain.com/crest/api");

resource.get("id", {
  queryString: {
      query: "value"
  }
})
// => http://www.domain.com/crest/api/id?query=value
```

ForgeRock CREST.js 应用的查询字符串不能被推翻 .

```js
import { CRESTv2 } from "@forgerock/crest-js";

const resource = new CRESTv2("http://www.domain.com/crest/api");

resource.action("action1", {
  queryString: {
      _action: "action2"
  }
})
// => http://www.domain.com/crest/api?_action=action1
```

### 中间软件

一个或许多中间软件可以被应用于 CREST 资源.

每个中件是一个函数,它需要一个单一的"承诺"参数,并返回一个"承诺"以传递给下一个中件.

链中的第一个中间器件可以保证得到一个承诺,它要么解析出JSON有效载荷,要么用定义的错误类型之一拒绝.

```js
import { CRESTv2_1 } from "@forgerock/crest-js";

const customMiddleware = (promise) => {
  return promise.then((json) => {
    // Success! `json` is an Object
    const jsonToReturn = {
      ...json,
      myAttribute: true
    };

    // Return value will be passed the next middleware
    return json;
  }, (error) => {
    // Capture, rethrow or modify errors
    throw new CustomError(error.message);
  });
};

const resource = new CRESTv2_1("http://www.domain.com/crest/api", {
  middleware: [customMiddleware]
});
```

## 发展

### 项目结构

```sh
dist/ # Output of "yarn run build".
config/ # Tooling configuration files.
docs/ # API documentation And output of "yarn run docs".
src/ # Source code.
├── .babelrc # Babel configuration for source when executing "yarn run test" or "yarn run test:coverage".
└── ...
```

### 大楼

将生产通用JS、ES和UMD版本制成 `/dist`。 。 。 .

```sh
yarn run build
```

### 文档

生成 API JSDoc 到 `/docs`。 。 。 .

```sh
yarn run docs
```

### 测试

运行测试对源.

```sh
yarn run test
```

这个 `yarn` 命令会将参数传递给基础命令。 示例,使用 `yarn run test --verbose --watch` 用于带有额外输出的连续测试.

### 测试范围

生成测试覆盖报告.

```sh
yarn run test:coverage
```

## 捐款

向ForgeRock CREST.js 投稿,通过打开拉出请求.

## 进一步阅读

-   [关于ForgeRock Community REST( 通用 REST) 问题](https://backstage.forgerock.com/docs/am/6.5/dev-guide/#sec-about-crest)
-   [CREST HTTP 协议的规格](https://stash.forgerock.org/projects/COMMONS/repos/forgerock-commons/browse/rest/Protocol.md)

## 常见问题

### @forgerock/crest-js 是什么？

与 ForgeRock CREST APIS 通信的轻量级库\.

### 如何安装 @forgerock/crest-js？

在项目目录运行 npm install @forgerock/crest-js，或使用 pnpm add / yarn add / bun add。

### @forgerock/crest-js 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/forgerock\_\_crest-js 是否存在。

### @forgerock/crest-js 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @forgerock/crest-js 可以商用吗？

@forgerock/crest-js 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @forgerock/crest-js 的下载量有多少？

根据 npm 官方下载统计，@forgerock/crest-js 在 2026/10/16 – 2026/11/14 这 30 天内被下载 8,399 次，日均约 280 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @forgerock/crest-js 还在维护吗？

最新版本 2\.1\.11 发布于 2022/04/12（4 年前）；至今共发布 17 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/11/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。