# @gooddata/gooddata-js 中文文档

规范地址：https://npmcn.com/package/%40gooddata/gooddata-js/

版本：13\.5\.0
npm 元数据更新时间：2026-10-27T14:12:06.436Z
中文译文更新时间：2026-11-16T19:17:28.544Z
软件包许可：BSD-3-Clause

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

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

弃用说明：@gooddata/gooddata-js reached End of Support on March 31, 2022\. Please upgrade \(see https://sdk\.gooddata\.com/gooddata-ui/docs/migration\_guide\_8\.html for more information\)\.

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

- 包体积（解压后）：2.3 MB，194 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- 首次发布：2018-04-12T16:27:19.272Z
- 最新版本发布：2021-02-10T17:32:47.444Z
- 近 30 天下载量：25432（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：380（近 12 个月 0 个）

## 中文简介

GoodData Java 脚本 SDK

## 安装

```sh
npm install @gooddata/gooddata-js
```

也可以使用：`pnpm add @gooddata/gooddata-js`、`yarn add @gooddata/gooddata-js`、`bun add @gooddata/gooddata-js`

## README

[![npm version](https://badge.fury.io/js/%40gooddata%2Fgooddata-js.svg)](https://www.npmjs.com/package/@gooddata/gooddata-js)

# GoodData JS SDK (英语)

> 关于 GoodData REST API 的细小 Javascript 抽象

## 开始

-   对于丰富的可视化,请使用 **古德达塔. 用户**数字 :
    -   [GoodData.UI 文档](http://sdk.gooddata.com/gooddata-ui/)
    -   [GoodData.UI (英语). 反应组件](https://github.com/gooddata/gooddata-react-components) 仓库
    -   页:1 [执行组件](https://sdk.gooddata.com/gooddata-ui/docs/execute_component.html) 用于自定义可视化
-   gooddata-js为特定的背景任务服务,但可用于浏览器和节点.js环境中的小应用程序.

## 使用量

### 使用 npm 软件包

1.  转到项目目录并添加软件包:  
    与 [线条](https://yarnpkg.com/)数字 : `yarn add @gooddata/gooddata-js`  
    与 [无](https://npmcn.com/package/%40gooddata/gooddata-js/npmjs.com)数字 : `npm install --save @gooddata/gooddata-js`
    
    : 沉重的 感叹 标记: **警告: npm 软件包重新命名自 `gooddata` 改为 `@gooddata/gooddata-js`** : 沉重的 感叹 标记:
    
2.  导入包的默认导出 :  
    \+ 在有ES6模块语法的转接浏览器应用中: `import { factory } from '@gooddata/gooddata-js';`  
    → 在同为通用JS语法的节点j: `const factory = require('@gooddata/gooddata-js').factory;`
    
3.  给API打电话:
    
    ```js
    var gooddata = factory({ domain: 'secure.gooddata.com' });
    gooddata.user.login('john.doe@example.com', 'your-secret-password')
        .then((response) => console.log('Login OK', response))
        .catch((apiError) => console.error('Login failed', apiError, "\n\n", apiError.responseBody));
    
    ```
    
4.  请注意,遥感中心可以防止这一请求。 参见 [您在 GoodData 中的选项。 UI 文档](https://sdk.gooddata.com/gooddata-ui/docs/cors.html), ie. 设置本地代理或请求 GoodData 平台允许特定域.
    

### 用作独立的图书馆

你有两种选择:

-   [下载 `gooddata.js` 或者说 `gooddata.min.js`](https://unpkg.com/@gooddata/gooddata-js@latest/dist/) 从最新版本
-   以你自己为基础:
    
    ```bash
    git clone https://github.com/gooddata/gooddata-js.git
    cd gooddata-js
    git checkout v6.0.0 # choose a version, or omit this line to use unstable code from `master` branch
    yarn install --pure-lockfile
    yarn build
    # get gooddata.js and gooddata.min.js from /dist folder
    ```
    

然后可以导入库文件和全局变量 `gooddata` 包含所有已导出的成员 :

```html
<script type="text/javascript" src="gooddata.js"></script>
<script type="text/javascript">
    var sdk = gooddata.factory({ domain: 'secure.gooddata.com' });
    sdk.user.login('john.doe@example.com', 'your-secret-password')
</script>
```

## 贡献:咖啡:

我们欢迎以下列形式提供的任何捐助: [问题](https://github.com/gooddata/gooddata-js/issues) 或者说 [拖动请求](https://github.com/gooddata/gooddata-js/pulls)。 。 。 .

安装 [节点.js](http://nodejs.org/) (节点12.16.1,npm v 6.13.4)和 [雅伦](https://classic.yarnpkg.com/) 1.22.4. (中文(简体) ).

这些命令在开发时可能有用:

| 命令 | 说明 |
| --- | --- |
| `yarn install --frozen-lockfile` | 第一步 |
| `yarn dev` | 建立良好数据js `/dist` 监视模式 |
| `yarn test` | 在监视模式下运行单元测试 |
| `yarn validate` | 验证代码样式( tslint) |
| `yarn build` | 构建通用js `/lib` 并捆绑文件到 `/dist` |
| `grunt yuidoc:compile` | 将 yui 文档构建为 `/docs` |

> 不要忘记更新 _变动情况_ 当贡献.

## 出版

: 沉重的 感叹 标记: **只针对内部的好数据开发者** : 沉重的 感叹 标记:

### 国家防范机制成套出版物

软件包的出版通过Jenkins Job进行:

[https://checklist.intgdc.com/job/client-libs/job/gooddata-js-release/ 页面存档备份,存于互联网档案馆](https://checklist.intgdc.com/job/client-libs/job/gooddata-js-release/)

### SDK API 文档出版

发布 API 文档 [sdk.gooddata.com/gooddata-js/api 页面存档备份,存于互联网档案馆](http://sdk.gooddata.com/gooddata-js/api) 命令:

| 命令 | 说明 |
| --- | --- |
| 1\. 联合国. `yarn build` |  |
| 2\. 联合国. `grunt bump-gh-pages` | 发布文档 |

## 更改日志

-   见 [变动情况](https://npmcn.com/package/%40gooddata/gooddata-js/CHANGELOG.md)

## 许可证

(C) 2007-2018 GoodData公司

详情请参见 [自由主义](https://github.com/gooddata/gooddata-js/blob/master/LICENSE)

## 常见问题

### @gooddata/gooddata-js 是什么？

GoodData Java 脚本 SDK注意：该包已被作者标记为弃用——@gooddata/gooddata-js reached End of Support on March 31, 2022\. Please upgrade \(see https://sdk\.gooddata\.com/gooddata-ui/docs/migration\_guide\_8\.html for more information\)\.

### 如何安装 @gooddata/gooddata-js？

在项目目录运行 npm install @gooddata/gooddata-js，或使用 pnpm add / yarn add / bun add。

### @gooddata/gooddata-js 支持 TypeScript 吗？

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

### @gooddata/gooddata-js 支持 ESM 还是 CommonJS？

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

### @gooddata/gooddata-js 可以商用吗？

@gooddata/gooddata-js 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @gooddata/gooddata-js 的下载量有多少？

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

### @gooddata/gooddata-js 还在维护吗？

最新版本 13\.5\.0 发布于 2021/02/11（5 年前）；至今共发布 380 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/04/13。作者已将其标记为弃用，新项目建议寻找替代方案。

