BaseOpenSDK（Node.js）官方文档

2023年11月7日创建

安装

npm

代码块

npm i -S @lark-base-open/node-sdk

yarn

代码块

yarn add @lark-base-open/node-sdk

如何使用

提供 ECMAScript，CommonJS 2个版本，支持原生 Javascript 和 Typescript 的使用，示例均以 Typescript 为例。​

ECMAScript

代码块

import { BaseClient } from '@lark-base-open/node-sdk';

CommonJS

代码块

const { BaseClient } = require('@lark-base-open/node-sdk');

API 调用

SDK 提供了语义化的调用方式，只需要提供相关参数创建 client 实例，接着使用其上的语义化方法client.[业务域].[资源].[方法]即可完成 API 调用，调用过程及调用结果均有完备的类型进行提示。例如列出 Base 数据表记录：​

代码块

import { BaseClient } from '@lark-base-open/node-sdk';​
​
// 新建 BaseClient，填上需要操作的 Base 文档对应的 appToken 和 personalBaseToken​
const client = new BaseClient({​
  appToken: 'xxx',​
  personalBaseToken: 'xxx'​
});​
​
// 列出数据表记录​
const res = await client.base.appTableRecord.list({​
  // 路径参数。我们会自动为你填充 app_token（appToken）参数，你无需手动添加​
  path: {​
    table_id: 'tblxxxxxx'​
  },​
  // 查询参数​
  params: {​
    page_size: 10,​
  },​
});​

接口对应的 Http 参数说明：

接口参数名	描述
path	Http 请求路径参数
params	Http 请求查询参数
data	Http 请求体

BaseClient构造参数：

参数	描述	类型	必须	默认
appToken	Base 文档的唯一标识，从 Base 网页的路径参数获取 /base/:app_token	string	是	-

BaseOpenSDK（Node.js）官方文档​

BaseOpenSDK（Node.js）官方文档