Getting Started

Welcome to Feishub! This is a powerful yet simple TypeScript SDK for Feishu multi-dimensional tables.

Installation

Install with npm:

npm install feishub

Install with yarn:

yarn add feishub

Install with pnpm:

pnpm add feishub

Basic Configuration

Getting Credentials

Before using Feishub, you need to obtain the following information from Feishu Open Platform:

1. App ID - Application ID
2. App Secret - Application Secret
3. App Token - Multi-dimensional table app token
4. Table ID - Table ID

Environment Variables (Optional)

You can set these credentials via environment variables:

# .env file
FEISHU_APP_ID=cli_xxxxxxxxxx
FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxx
FEISHU_APP_TOKEN=xxxxxxxxxxxxxxxxxx
FEISHU_TABLE_ID=xxxxxxxxxxxxxxxxxx

Basic Usage

Method 1: Using Feishu Class

import { Feishu } from "feishub";

// Create Feishu instance
const feishu = new Feishu({
  appId: "cli_xxxx",
  appSecret: "xxxx",
});

// Create table instance
const table = feishu.table({
  tableId: "xxxx",
  appToken: "xxxx",
});

// Get table metadata
const meta = await table.meta();
console.log(meta);

Method 2: Using Table Class Directly

import { Table, Feishu } from "feishub";

// Create Feishu client
const feishu = new Feishu({
  appId: "cli_xxxx",
  appSecret: "xxxx",
});

// Create table instance directly
const table = new Table({
  appToken: "xxxx",
  tableId: "xxxx",
  feishu,
});

Method 3: Using Environment Variables

If you have set environment variables, you can create instances more simply:

import { Table } from "feishub";

// Will automatically read configuration from environment variables
const table = new Table();

Basic Operation Examples

Insert Record

const result = await table.insert({
  name: "John Doe",
  age: 25,
  email: "john@example.com"
});

if (result) {
  console.log("Insert successful:", result.record_id);
} else {
  console.log("Insert failed");
}

Search Records

const searchResult = await table.search({
  filter: {
    conjunction: "and",
    conditions: [
      {
        field_name: "name",
        operator: "equal",
        value: ["John Doe"]
      }
    ]
  }
});

if (searchResult?.items) {
  console.log("Found records:", searchResult.items.length);
}

Update Record

const updated = await table.update("record_id", {
  age: 26
});

if (updated) {
  console.log("Update successful");
}

Delete Record

const deleted = await table.delete("record_id");

if (deleted) {
  console.log("Delete successful");
}

Next Steps

Now that you understand the basic usage, you can continue learning:

• Table Operations - Learn about various table operations
• Search and Filter - Learn advanced search functionality
• Error Handling - Learn how to handle error situations