@adobe/aem-headless-client-nodejs

中文文档
2.0.1发布于 2025/10/07Apache-2.0CommonJS近 30 天下载 4761

AEM 无头 SDK 客户端节点JS

中文使用文档
文档目录10 节
  1. 安装
  2. 使用量
  3. 创建无头客户端
  4. 使用无头客户端
  5. 获取实例
  6. 授权
  7. DEV 证书和服务证书
  8. API 参考
  9. 捐款
  10. 许可证发放

Version Downloads/week Build Status License

节点JS 无头客户端 AEM

见 无头客户-贾瓦 用于此客户端的 Java 变体 财务报告和审定财务报表 无头客户-js 仅用于客户端浏览器的变体.

安装

$ npm install @adobe/aem-headless-client-nodejs

使用量

创建无头客户端

const { AEMHeadless } = require('@adobe/aem-headless-client-nodejs');

配置 SDK 与 ServiceURL 和 Auth 数据( 如果需要)

const aemHeadlessClient = new AEMHeadless({
    serviceURL: '<aem_host>',
    endpoint: '<graphql_endpoint>',
    auth: '<aem_token>' || ['<aem_user>', '<aem_pass>']
})
// Eg:
const aemHeadlessClient = new AEMHeadless({
    serviceURL: AEM_HOST_URI,
    endpoint: 'content/graphql/endpoint.gql',
    auth: [AEM_USER, AEM_PASS]
})

使用无头客户端

承诺语法 :

aemHeadlessClient.runQuery(queryString)
  .then(data => console.log(data))
  .catch(e => console.error(e.toJSON()))

aemHeadlessClient.listPersistedQueries()
   .then(data => console.log(data))
   .catch(e => console.error(e.toJSON()))

aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
   .then(data => console.log(data))
   .catch(e => console.error(e.toJSON()))

aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
   .then(data => console.log(data))
   .catch(e => console.error(e.toJSON()))

在同步/等待中:

(async () => {
    let postData
    try {
        postData = await aemHeadlessClient.runQuery(queryString)
    } catch (e) {
        console.error(e.toJSON())
    }
    
    let list
    try {
        list = await aemHeadlessClient.listPersistedQueries()
    } catch (e) {
        console.error(e.toJSON())
    }

    try {
        await aemHeadlessClient.persistQuery(queryString, 'wknd/persist-query-name')
    } catch (e) {
        console.error(e.toJSON())
    }
    
    let getData
    try {
        getData = await aemHeadlessClient.runPersistedQuery('wknd/persist-query-name')
    } catch (e) {
        console.error(e.toJSON())
    }
})()    

获取实例

检查 https://github.com/adobe/aio-lib-core-networking (中文(简体) ) 用于高级使用和默认设置

授权

若为 auth param是一个字符串,它被当作是"熊"的代号

若为 auth param 是一个数组,预期数据为 ['user','pass'] 对等,基本授权将被去除

若为 auth 未定义, 授权信头将不会设置

DEV 证书和服务证书

SDK 包含从证书配置文件获取 Auth 令牌的帮助功能

const { getToken } = require('@adobe/aem-headless-client-nodejs')
(async () => {
    const { accessToken, type, expires } = await getToken('path/to/service-config.json')
    const aemHeadlessClient = new AEMHeadless('content/graphql/endpoint.gql', AEM_HOST_URI, accessToken)
    const data = await aemHeadlessClient.runQuery(queryString)
})()

API 参考

见生成 API 参考

捐款

欢迎捐款! 读取 贡献指南 更多信息.

许可证发放

这个项目根据Apache V2许可证获得许可. 见 自由主义 更多信息.

版本与发布记录

@adobe/aem-headless-client-nodejs 共发布 5 个版本,首次发布于 2021/06/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.1latest2025/10/071.1 年前
2.0.02024/07/112 年前
1.1.12024/07/112 年前
1.1.02022/01/304 年前
1.0.22021/06/045 年前

关于 @adobe/aem-headless-client-nodejs 的常见问题

@adobe/aem-headless-client-nodejs 是什么?

AEM 无头 SDK 客户端节点JS

如何安装 @adobe/aem-headless-client-nodejs?

在项目目录运行 npm install @adobe/aem-headless-client-nodejs,或使用 pnpm add / yarn add / bun add。

@adobe/aem-headless-client-nodejs 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/adobe__aem-headless-client-nodejs 是否存在。

@adobe/aem-headless-client-nodejs 支持 ESM 还是 CommonJS?

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

@adobe/aem-headless-client-nodejs 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@adobe/aem-headless-client-nodejs 可以商用吗?

@adobe/aem-headless-client-nodejs 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@adobe/aem-headless-client-nodejs 的下载量有多少?

根据 npm 官方下载统计,@adobe/aem-headless-client-nodejs 在 2026/10/05 – 2026/11/03 这 30 天内被下载 4,761 次,日均约 159 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@adobe/aem-headless-client-nodejs 还在维护吗?

最新版本 2.0.1 发布于 2025/10/07(1.1 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/06/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。