# @fnndsc/chrisapi 中文文档

规范地址：https://npmcn.com/package/%40fnndsc/chrisapi/

版本：1\.25\.0
npm 元数据更新时间：2026-08-24T19:25:42.748Z
中文译文更新时间：2026-11-15T03:52:28.561Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fnndsc/chrisapi
原文对照：https://npmcn.com/package/%40fnndsc/chrisapi/?lang=original

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

- 包体积（解压后）：1.2 MB，74 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2018-10-23T23:27:10.183Z
- 最新版本发布：2026-06-18T16:01:43.625Z
- 近 30 天下载量：3483（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：86（近 12 个月 3 个）

## 中文简介

Chris API 的 JavaScript6 客户端

## 安装

```sh
npm install @fnndsc/chrisapi
```

也可以使用：`pnpm add @fnndsc/chrisapi`、`yarn add @fnndsc/chrisapi`、`bun add @fnndsc/chrisapi`

## README

# 克里斯 API

[![Build Status](https://app.travis-ci.com/FNNDSC/fnndsc.svg?branch=master)](https://app.travis-ci.com/FNNDSC/fnndsc)

Chris API的JavaScript 6客户端.

## 安装

```bash
npm i @fnndsc/chrisapi
```

## API 文档

如果您有 ChRIS 服务器在运行( 如以下解释), 您可以在您的 Javascript 代码中测试 API .

详情请访问 [API 文档](https://fnndsc.github.io/fnndsc/chrisdoc/index.html)

## 开发和测试

### ChRIS 服务器先决条件

这些先决条件只有在能够对客户进行实际测试时才有必要 用于自动测试.

#### 安装最新的 Docker

目前测试的平台 :

-   `Docker Engine v25.0.0+`

#### 在 Linux 机上确保将您的计算机用户添加到 `docker group`

#### 安装最新 [`just`](https://just.systems/) 指挥跑者.

#### 启动全套Chris服务:

打开终端并在任何工作目录中运行以下命令 :

```bash
$> git clone https://github.com/FNNDSC/ChRIS_ultron_backEnd.git
$> cd ChRIS_ultron_backEnd
$> just
```

检查所有服务是否齐全 :

```bash
$> docker ps -a
```

#### 创建测试数据 :

在此 README 文件目录中运行以下 shell 脚本 . 注:剧本取决于大众 `curl` 财务报告和审定财务报表 `jq` 命令行工具.

```bash
$> ./pre_test.sh
```

#### 拆掉全套Chris服务:

以后可以移除所有后端容器并释放存储量,其中:

```bash
$ cd ChRIS_ultron_backEnd
$ just nuke
```

### JavaScript 软件包管理器的先决条件

-   线条

在此 README 文件目录中打开终端

### 图标

安装依赖关系

```bash
$> yarn install
```

以监视模式开始测试( 用于开发)

```bash
$> yarn start
```

在单跑模式下开始测试( 由 `Travis CI`(中文(简体) )

```bash
$> yarn test
```

编译库以独立捆绑

```bash
$> yarn build
```

生成源代码文档

```bash
$> yarn docs
```

## 常见问题

### @fnndsc/chrisapi 是什么？

Chris API 的 JavaScript6 客户端

### 如何安装 @fnndsc/chrisapi？

在项目目录运行 npm install @fnndsc/chrisapi，或使用 pnpm add / yarn add / bun add。

### @fnndsc/chrisapi 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fnndsc/chrisapi 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fnndsc/chrisapi 可以商用吗？

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

### @fnndsc/chrisapi 的下载量有多少？

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

### @fnndsc/chrisapi 还在维护吗？

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