Back to Details

tinybird-typescript-sdk-guidelines

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Tinybird TypeScript SDK Guidelines

Tinybird TypeScript SDK 使用指南

Guidance for using the

@tinybirdco/sdk

package to define Tinybird resources in TypeScript with complete type inference.

本指南介绍如何使用

@tinybirdco/sdk

包在TypeScript中定义Tinybird资源，实现完整的类型推断。

When to Apply

适用场景

Installing or configuring @tinybirdco/sdk
Defining datasources or pipes in TypeScript
Creating typed Tinybird clients
Using type-safe ingestion or queries
Running tinybird dev/build/deploy commands for TypeScript projects
Migrating from legacy .datasource/.pipe files to TypeScript

安装或配置@tinybirdco/sdk
在TypeScript中定义数据源或管道
创建类型化的Tinybird客户端
使用类型安全的导入或查询
为TypeScript项目运行tinybird dev/build/deploy命令
从传统的.datasource/.pipe文件迁移到TypeScript

Rule Files

规则文件

```
rules/getting-started.md
```
```
rules/configuration.md
```
```
rules/defining-datasources.md
```
```
rules/defining-endpoints.md
```
```
rules/typed-client.md
```
```
rules/low-level-api.md
```
```
rules/cli-commands.md
```

```
rules/getting-started.md
```
```
rules/configuration.md
```
```
rules/defining-datasources.md
```
```
rules/defining-endpoints.md
```
```
rules/typed-client.md
```
```
rules/low-level-api.md
```
```
rules/cli-commands.md
```

Quick Reference

快速参考

Install:
```
npm install @tinybirdco/sdk
```
Initialize:
```
npx tinybird init
```
Dev mode:
```
tinybird dev
```
(watches and syncs to branches, not main)
Deploy:
```
tinybird deploy
```
(deploys to main/production)
Server-side only; never expose tokens in browsers

安装：
```
npm install @tinybirdco/sdk
```
初始化：
```
npx tinybird init
```
开发模式：
```
tinybird dev
```
（监听并同步到分支，而非主分支）
部署：
```
tinybird deploy
```
（部署到主分支/生产环境）
仅适用于服务端；切勿在浏览器中暴露令牌