# @ephox/jax 中文文档

规范地址：https://npmcn.com/package/%40ephox/jax/

版本：9\.0\.0
npm 元数据更新时间：2026-03-31T04:20:31.747Z
中文译文更新时间：2026-11-13T19:29:17.084Z
软件包许可：GPL-2\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40ephox/jax
原文对照：https://npmcn.com/package/%40ephox/jax/?lang=original
项目主页：https://github.com/tinymce/tinymce#readme
源码仓库：https://github.com/tinymce/tinymce

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

- 包体积（解压后）：119 kB，90 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2016-12-20T05:37:02.615Z
- 最新版本发布：2026-03-31T04:20:31.633Z
- 近 30 天下载量：16353（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 1 个）

## 中文简介

AJAX 图书馆

## 安装

```sh
npm install @ephox/jax
```

也可以使用：`pnpm add @ephox/jax`、`yarn add @ephox/jax`、`bun add @ephox/jax`

## README

# 说明

`jax` 是一个处理 AJAX 请求和响应的库。 它没有捆绑任何命令。 这只是一组模块.

# 安装

`jax` 可作为 `npm` 软件包。 您可以通过 npm 软件包安装 `@ephox/jax`

## 从 npm 安装

`npm install @ephox/jax`。 。 。 .

# 使用 API

`jax` 支持几种方法、内容类型和响应类型。 更具体地说,

方法: 获取、 POST、 PUT、 DELETE 内容类型: 无, 形式, json, plain, html 反应类型:json、blob、文本、html、xml

还有, `credentials` 可随请求而发送。 更多信息可以找到 [这里](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials)。 。 。 .

这个 `ephox.jax.api.Ajax` API提供了提出AJAX请求的各种方法. 他们都回来了 `LazyValue` (见 [卡塔马里](https://www.npmjs.com/package/@ephox/katamari)),是一个类似承诺的数据结构,带有 `get`, (中文(简体) ), `map`,以及 `isReady` 函数。 APIs 还在结尾处为任何自定义请求头取一个额外的参数,默认为 `{}` 若不提供则提供.

`ContentType`, (中文(简体) ), `ResponseType`,以及 `Credentials` 使用内部的构造器指定 `ephox.jax.api.ContentType`, (中文(简体) ), `ephox.jax.api.ResponseType`,以及 `ephox.jax.api.Credentials` 页:1.

## 获取请求

`Ajax.get(url, responseType, credentials, _custom)`

此点出带有指定响应类型的 GET 请求 。 内容类型以 `none`。 。 。 .

```
Ajax.get(
  'http://localhost/server/get/1',
  ResponseType.json(),
  Credentials.none(),
  { }
).get(function (result) {
  // result is a result, so you need to fold over it for Err or Succ(x)
  result.fold(function (err) {
    console.error('Server error', err);
  }, function (val) {
    console.log('Get response', val);
  })
});
```

## 后请求

`Ajax.post(url, contentType, responseType, credentials, _custom)`

此点出 POST 请求, 附带指定的响应类型和内容类型 .

```
Ajax.post(
  'http://localhost/server/post',
  ContentType.json({
    'send-data': '10'
  }),
  ResponseType.xml(),
  Credentials.none(),
  { }
)).get(function (result) {
  // result is a result, so you need to fold over it for Err or Succ(x)
  result.fold(function (err) {
    console.error('Server error', err);
  }, function (xml) {
    console.log('Post response', xml);
  })
});
```

## PUT 请求

`Ajax.put(url, contentType, responseType, credentials, _custom)`

此点出 PUT 请求, 包含指定的响应类型和内容类型 .

```
Ajax.put(
  'http://localhost/server/put',
  ContentType.json({
    'send-data': '10'
  }),
  ResponseType.json(),
  Credentials.none(),
  { }
)).get(function (result) {
  // result is a result, so you need to fold over it for Err or Succ(x)
  result.fold(function (err) {
    console.error('Server error', err);
  }, function (val) {
    console.log('Put response', val);
  })
});
```

## DELETE 请求

`Ajax.del(url, responseType, credentials, _custom)`

此点出带有指定响应类型的 DELETE 请求 .

```
Ajax.get(
  'http://localhost/server/del/1',
  ResponseType.json(),
  Credentials.none(),
  { }
).get(function (result) {
  // result is a result, so you need to fold over it for Err or Succ(x)
  result.fold(function (err) {
    console.error('Server error', err);
  }, function (val) {
    console.log('Delete response', val);
  })
});
```

# 运行测试

`$ yarn test`

这些测试要求 [基石](https://www.npmjs.com/package/@ephox/bedrock) 和铬.

## 常见问题

### @ephox/jax 是什么？

AJAX 图书馆

### 如何安装 @ephox/jax？

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

### @ephox/jax 支持 TypeScript 吗？

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

### @ephox/jax 支持 ESM 还是 CommonJS？

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

### @ephox/jax 可以商用吗？

@ephox/jax 使用 GPL-2\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以兼容的 GPL 许可开源。仅在内部使用、不对外分发时不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @ephox/jax 的下载量有多少？

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

### @ephox/jax 还在维护吗？

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

