# @farm\.js/contentful 中文文档

规范地址：https://npmcn.com/package/%40farm.js/contentful/

版本：0\.1\.48
npm 元数据更新时间：2026-11-01T00:42:42.737Z
中文译文更新时间：2026-11-01T03:35:58.028Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40farm.js/contentful
原文对照：https://npmcn.com/package/%40farm.js/contentful/?lang=original
项目主页：https://github.com/farming-labs/farm.js#readme
源码仓库：https://github.com/farming-labs/farm.js

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

- 包体积（解压后）：11.9 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：contentful ^10\.0\.0 \|\| ^11\.0\.0，@farm\.js/content ^0\.1\.0-beta\.46
- 首次发布：2026-09-24T20:53:25.658Z
- 最新版本发布：2026-11-01T00:42:42.568Z
- 已发布版本数：61（近 12 个月 61 个）

## 中文简介

内容丰富的Farm.js内容源

## 安装

```sh
npm install @farm.js/contentful
```

也可以使用：`pnpm add @farm.js/contentful`、`yarn add @farm.js/contentful`、`bun add @farm.js/contentful`

## README

# @farm.js /意旨

内容丰富的内容来源 [Farm.js](https://github.com/farming-labs/farm.js)． 提要意旨 条目到 `@farm.js/content` 集合，它们得到相同的模式验证，转换， 生成的服务器类型为本地Markdown。

```ts
import { collection, content } from "@farm.js/content";
import { contentfulSource } from "@farm.js/contentful";

content({
  collections: {
    posts: collection({
      source: contentfulSource({
        contentType: "post",
        query: { order: ["-sys.createdAt"] },
        refreshInterval: 30_000, // dev only
      }),
      schema: post,
    }),
  },
});
```

集 `CONTENTFUL_SPACE_ID` 和 `CONTENTFUL_ACCESS_TOKEN`，或传递现有客户端 `client`． 条目id默认为字符串 `fields.slug`，退回到 `sys.id`． 分页的过去 Contentful的1000个条目页面上限是在内部处理的。对于草稿，请设置 `host: "preview.contentful.com"` 与 `CONTENTFUL_PREVIEW_TOKEN`.

内容是构建时快照：在配置加载和绑定时获取条目 转化为生产产出。将Contentful webhook指向平台的deploy钩子，以便在其上进行重建 发布。看到 [内容插件文档](https://farmjs.dev/docs/plugins/content) 对于共享的 管道和直播内容替代方案。

## 常见问题

### @farm\.js/contentful 是什么？

内容丰富的Farm\.js内容源

### 如何安装 @farm\.js/contentful？

在项目目录运行 npm install @farm\.js/contentful，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：contentful（^10\.0\.0 \|\| ^11\.0\.0）、@farm\.js/content（^0\.1\.0-beta\.46）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farm\.js/contentful 支持 TypeScript 吗？

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

### @farm\.js/contentful 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @farm\.js/contentful 可以商用吗？

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

### @farm\.js/contentful 还在维护吗？

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