supabase-management-js (西班牙语)
方便包装 Supabase 管理 API 用 TypeScript 写出.
状态
管理API在β. 它在目前状态下可以使用,但很可能会出现断裂变化.
安装
要安装 supabase-management-js 在节点项目中:
npm install supabase-management-js
supabase-management-js 需要18和18个以上节点,因为它依赖当地人 fetch 客户端.
认证
您可以配置 SupabaseManagementAPI 类,带有访问符,通过 奥奥特 或通过生成 API 令牌 账户 页 次 您的 API 令牌带有与您的用户账户相同的权限, 所以请务必保密 .
import { SupabaseManagementAPI } from "supabase-management-js";
const client = new SupabaseManagementAPI({ accessToken: "<access token>" });
使用量
这个 SupabaseManagementAPI 类曝光 API 的每个端点 管理层 API 作为返回带有相应响应数据类型的“承诺”的函数.
import { SupabaseManagementAPI } from "supabase-management-js";
const client = new SupabaseManagementAPI({ accessToken: "<access token>" });
const projects = await client.getProjects();
if (projects) {
console.log(`Found ${projects.length} projects`);
}
处理错误
反应错误被抛出作为 SupabaseManagementAPIError 它是一个子类 Error。您可以使用导出 isSupabaseError 守护功能以缩小类型 unknown 错误对象 :
import { SupabaseManagementAPI, isSupabaseError } from "supabase-management-js";
const client = new SupabaseManagementAPI({ accessToken: "<access token>" });
try {
await client.getProjects();
} catch (error) {
if (isSupabaseError(error)) {
// error is now typed as SupabaseManagementAPI
console.log(
`Supabase Error: ${error.message}, response status: ${error.response.status}`
);
}
}
捐款
对这个项目的贡献是十分受欢迎和高度赞赏的!
-
将回放切入公共 GitHub 回放( 或分叉) https://github.com/supabase-community/supabase-管理-js/fork 互联网档案馆的存檔,存档日期2013-12-11) (中文(简体) ).
-
转到项目文件夹 .
cd supabase-management-js
- 安装软件包
npm数字 :
npm install
-
做你的改变
-
确保类型正确
npm run typecheck
- 如果您正在修改源代码以影响其公共 API 的更改, 则创建更改列表来描述您的更改
npm exec changeset
- 创建分支, 执行您的更改, 并打开 Pull 请求以对抗
main树枝在这个repo.
恢复类型
这个 v1.d.ts (中文(简体) ) 文件基于 Supabase 自动生成 OpenAPI 光谱 带有以下命令的文件 :
npm run generate