# @financial-times/x-engine 中文文档

规范地址：https://npmcn.com/package/%40financial-times/x-engine/

版本：21\.2\.3
npm 元数据更新时间：2026-10-26T09:15:02.574Z
中文译文更新时间：2026-11-14T18:31:12.669Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40financial-times/x-engine
原文对照：https://npmcn.com/package/%40financial-times/x-engine/?lang=original
项目主页：https://github.com/Financial-Times/x-dash/tree/HEAD/packages/x-engine
源码仓库：https://github.com/Financial-Times/x-dash

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

- 包体积（解压后）：12.3 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：16\.x \|\| 18\.x \|\| 20\.x
- 运行依赖：1 个
- peer 依赖：webpack \>=4\.0\.0
- 首次发布：2018-04-12T09:10:06.279Z
- 最新版本发布：2026-10-26T09:15:02.049Z
- 近 30 天下载量：12745（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：208（近 12 个月 17 个）

## 中文简介

这个模块是一个集成库,用于渲染任何兼容运行时间的x-dash组件.

## 安装

```sh
npm install @financial-times/x-engine
```

也可以使用：`pnpm add @financial-times/x-engine`、`yarn add @financial-times/x-engine`、`bun add @financial-times/x-engine`

## README

# x- 发动机

此模块是一个集成库 `x-dash` 任何兼容运行时间的组件.

## 安装

此模块在节点12上得到支持,并在npm上得到分发.

```bash
npm install -S @financial-times/x-engine
```

您还需要安装您选择的运行时间和任何相关的依赖性 。 一些兼容的运行时间是:

-   [超应用程序](https://github.com/hyperapp/hyperapp)\* 联合国
-   [超声波](https://github.com/i-like-robots/hyperons)
-   [地狱](https://infernojs.org/)
-   [神经病](https://github.com/NervJS/nerv)
-   [预录](https://preactjs.com/)
-   [拉克斯语Name](https://alibaba.github.io/rax/)
-   [反应](https://reactjs.org/)
-   [VDO 维多](https://github.com/DylanPiercey/vdo)

\* Hyperapp的使用取决于对高阶组件的小修改才能接受 `children` 作为第二个论据,而不是收到所附的理由 `props`。 。 。 .

## 配置

要启动, 您必须在内部指定运行时间配置 `package.json`。此指示 `x-engine` 用于您环境的模块。 您可以根据您的需要指定不同的服务器和浏览器渲染运行时间 .

这个模块包括几个流行工具和框架的预设,包括React,Preact,和Hyperons. 例如,在服务器上使用Hyperons,在浏览器中使用Preact,您可以使用其预设的名称:

```json
{
    "x-dash": {
        "engine": {
            "server": "hyperons",
            "browser": "preact"
        }
    }
}
```

但如果您所选择的工具没有预设,则可以提供扩展的配置格式。 下面的例子说明如何装入 VDO 模块并使用其 `createElement` 工厂函数\* 联合国数字 :

```json
{
    "x-dash": {
        "engine": {
            "server": {
                "runtime": "vdo",
                "factory": "createElement"
            }
        }
    }
}
```

\* JSX工厂职能是一种变相职能页:1 签名 `fn(element, properties, ...children)`,示例包括: `React.createElement` 财务报告和审定财务报表 `Preact.h`见 [FAQ 区域](https://npmcn.com/package/%40financial-times/x-engine/#readme-faq) 更多信息.

• Variadic 表示该函数接受数量不等的参数。 这个 `...` 在最后的参数名称是休息参数之前,表示它会收集"其余"参数.

## 渲染

### 服务器侧

如果选中的运行时工厂返回字符串, 您可以将属性传递到组件, 并立即使用返回的值 :

```js
const { Teaser } = require('@financial-times/x-teaser');

app.get('/teaser', (request, response) => {
    const properties = { … };
    response.send(Teaser(properties));
});
```

但是,如果你的工厂方法返回一个特定框架的中间代码,那么你需要加载指定的渲染方法来使节点变成字符串或流:

```js
const { render } = require('@financial-times/x-engine');
const { Teaser } = require('@financial-times/x-teaser');

app.get('/teaser', (request, response) => {
    const properties = { … };
    const nodes = Teaser(properties);
    response.send(render(nodes));
});
```

### 客户端

要在客户端使用组件, 您首先需要添加 `x-engine` 您的 Webpack 配置文件的插件 。 盖子下面这个用 [`DefinePlugin`](https://webpack.js.org/plugins/define-plugin/) 连接您选择的运行时间.

```js
// webpack.config.js
const xEngine = require('@financial-times/x-engine/src/webpack');

module.exports = {
    plugins: [
        xEngine()
    ]
};
```

然后可以安装和使用 `x-` 在客户端代码中的组件 :

```jsx
import { h } from '@financial-times/x-engine';
import { Teaser } from '@financial-times/x-teaser';

export default const TeaserList = (props) => (
    <ul class="TeaserList">
        {props.items.map((item) => (
            <li className="TeaserList-Item">
                <Teaser {...item} layout="small" showImage={true} />
            </li>
        ))}
    </ul>
);
```

#### 通过 n-ui 客户端

为了配置 n-ui 编译基于 x- dash `.jsx` 您还需要将以下文件添加到 `n-ui-build.config.js`。 。 。 .

```js
// n-ui-build.config.js
const xEngine = require('@financial-times/x-engine/src/webpack');

module.exports = {
    plugins: [
        xEngine()
    ],
    pragma: 'h'
};
```

您还需要从 `x-engine` 每个 `.jsx` 文档.

```javascript
import { h } from '@financial-times/x-engine'
```

## 财务问题

### 这听起来很复杂... 是魔力黑盒吗?

没有魔法 服务器边集成的源代码不到60行的不刺激代码. 用于客户端使用的Webpack插件甚至更小.

### 什么是"构件功能"?

工厂功能是带有签名的活字函数 `fn(element, properties, ...children)`,示例包括: `React.createElement` 财务报告和审定财务报表 `Preact.h`。它可能返回框架对 HTML 节点或格式化字符串的表示,这取决于您使用的运行时间.

### 我该用哪段时间?

随便你 反应,Preact,Rax,和Nerv基本上都是相容的. 如果你不希望一个框架的间接费用,或者正在渲染静态的HTML,那么就值得调查Hyperons或VDO模块.

### 超标呢?

超标当前只支持通过标记名(a string)作为第一个参数. 此限制意味着您目前无法参考其他组件中的组件 .

## 常见问题

### @financial-times/x-engine 是什么？

这个模块是一个集成库,用于渲染任何兼容运行时间的x-dash组件\.

### 如何安装 @financial-times/x-engine？

在项目目录运行 npm install @financial-times/x-engine，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：webpack（\>=4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @financial-times/x-engine 支持 TypeScript 吗？

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

### @financial-times/x-engine 支持 ESM 还是 CommonJS？

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

### @financial-times/x-engine 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js 16\.x \|\| 18\.x \|\| 20\.x。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @financial-times/x-engine 可以商用吗？

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

### @financial-times/x-engine 的下载量有多少？

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

### @financial-times/x-engine 还在维护吗？

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