# @dendronhq/airtable 中文文档

规范地址：https://npmcn.com/package/%40dendronhq/airtable/

版本：0\.11\.1
npm 元数据更新时间：2022-04-05T03:44:31.290Z
中文译文更新时间：2026-11-12T00:18:34.764Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：219 kB，87 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=8\.0\.0
- 运行依赖：6 个
- 首次发布：2021-10-02T23:15:01.943Z
- 最新版本发布：2021-10-02T23:15:02.325Z
- 近 30 天下载量：3803（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

官方Airtable JavaScript库.

## 安装

```sh
npm install @dendronhq/airtable
```

也可以使用：`pnpm add @dendronhq/airtable`、`yarn add @dendronhq/airtable`、`bun add @dendronhq/airtable`

## README

官方Airtable JavaScript库.

# 飞机列表.js

Airtable API 提供了一个简单的访问方式 数据。 无论是联系人,销售线索,存货,申请人 信息或待办事宜,相互作用的词汇 匹配您的数据结构。 您将使用您的表格名地址 表格,可访问这些列所存储数据的列名。 单位 换句话说,空气表 API是你自己的 RESTful API 对于你的 基础.

# 安装

### 节点.js

在节点工程中安装 airtable.js :

```
npm install airtable
```

Airtable.js与节点10及以上兼容.

### 浏览器

要在浏览器中使用 airtable.js,请使用 [空气表 浏览器 js](https://github.com/Airtable/airtable.js/blob/master/build/airtable.browser.js) 位于 `build` 文件夹.

演示,运行:

```
cd test/test_files
python -m SimpleHTTPServer
```

编辑 `test/test_files/index.html` - 把你们的 `BASE_ID` 财务报告和审定财务报表 `API_KEY` (小心点! ) 你把你的API密钥放在网页上! 创建一个单独的账户,与其共享一个基础).

然后在您的浏览器中打开 http://localhost: 8000 .

Airtable.js与Airtable网络应用支持的浏览器相兼容,可与Airtable网络应用兼容 除了萨法里1分 airtable.js支持Safari 10.1及更高. 见 [技术要求](https://support.airtable.com/hc/en-us/articles/217990018) 更多细节.

# 配置

有三种可供选择的办法:

-   `apiKey` - 给您的 API 暗号设置标志 访问 [您的账户页面](https://airtable.com/account) 创建 API 令牌。 ()`AIRTABLE_API_KEY`(中文(简体) )
-   `endpointUrl` - API的终点要击中。 您可能想要覆盖 如果您正在使用 API 代理( 如 runscope.net) 调试您的 API 调用 。 (`AIRTABLE_ENDPOINT_URL`(中文(简体) )
-   `requestTimeout` - 请求的超时(以毫秒计) 默认为5分钟( E)`300000`(中文(简体) )

您可以通过 `Airtable.configure`数字 :

```
Airtable.configure({ apiKey: 'YOUR_SECRET_API_KEY' })
```

在全球范围通过流程嵌入(例如12要素设置).

```
export AIRTABLE_API_KEY=YOUR_SECRET_API_KEY
```

您也可以覆盖每个连接的设置 :

```
var airtable = new Airtable({endpointUrl: 'https://api-airtable-com-8hw7i1oz63iz.runscope.net/'})
```

# 交互式文件

转到 [https://airtable.com/api 页面存档备份,存于互联网档案馆](https://airtable.com/api) 查看您的 AirTable 基地的 API 交互式文档。 一旦您选择一个碱基,请单击"JavaScript"标签来查看使用 Airtable.js 的代码片段. 它会用这个库为您对基地进行的所有操作提供示例.

# 承诺

截止 [页:1](https://github.com/Airtable/airtable.js/releases/tag/v0.5.0) 所有的方法都要求 `done` 召回将返回一个承诺,如果你不通过 `done` 调用.

例如:

```js
table.select().firstPage(result => { ... })
```

等同为

```js
table.select().firstPage().then(result => { ... })
```

# 测试

测试通过 `npm run test`。 。 。 .

我们争取100%的测试覆盖率。 某些方面可能无法检验或不适合 测试范围。 工具支持忽略文件的特定部分 [此处记录](https://github.com/istanbuljs/nyc#parsing-hints-ignoring-lines);酌情使用.

当您运行测试时, 将生成覆盖报告 `./coverage/lcov-report/index.html` 您可以在浏览器中访问,以便逐行报告.

## 常见问题

### @dendronhq/airtable 是什么？

官方Airtable JavaScript库\.

### 如何安装 @dendronhq/airtable？

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

### @dendronhq/airtable 支持 TypeScript 吗？

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

### @dendronhq/airtable 支持 ESM 还是 CommonJS？

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

### @dendronhq/airtable 需要什么版本的 Node\.js？

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

### @dendronhq/airtable 可以商用吗？

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

### @dendronhq/airtable 的下载量有多少？

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

### @dendronhq/airtable 还在维护吗？

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