Cliente e serviços
O ponto de entrada do SDK: como criar o cliente e quais serviços ele expõe.
6 min lido·Nível referência·Revisado em 12 de out. de 2026
Este texto em inglês foi gerado automaticamente a partir do original em francês e ainda não foi revisado.
Esta página foi traduzida automaticamente. A versão em inglês é oficial.
#
Funções
Funções exportadas
| Função | Descrição |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Crie uma nova instância do cliente Aurabase. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Cria um cliente para SERVER, use apenas para operações de administração (client.authAdmin: listar/criar/banir usuários, ler auditoria). |
#
Classe
AuraCliente
Cliente Aurabase principal.
| Propriedade | Descrição |
|---|---|
readonly baseUrl: string | URL do projeto (https://<slug>.aurabase.cloud), sem barra final. |
readonly apiKey: string | null | Chave API do projeto (anon ou service_role) enviada no cabeçalho apikey; null se nenhum foi fornecido. |
readonly fetchFn: typeof globalThis.fetch | Função fetch usada para todas as consultas (a de options.fetch, caso contrário globalThis.fetch). |
readonly authStore: BaseAuthStore | Armazenamento de sessão (token de acesso, token de atualização, usuário): memória, localStorage ou cookies dependendo do contexto. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Política de retomada de solicitação de leitura (GET, HEAD) em caso de erro transitório: habilitado ou não, e número máximo de reinicializações. |
readonly requestTimeoutMs?: number | Tempo limite padrão (ms) para solicitações JSON sem sinal. undefined → falha central (30s). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Gancho de observabilidade — consulte AuraClientOptions.onEvent. |
readonly debug?: boolean | Jornalize cada AuraObservabilityEvent via console.debug — veja AuraClientOptions.debug. |
get auth(): AuthService | Serviço de autenticação: registro, conexão, sessão, MFA, OAuth, identidades. |
get authAdmin(): AuthAdminService | API de administração de autenticação (usuários, sessões, log de auditoria, modelos de email). |
get db(): DatabaseService<Database, Schema> | Serviço de banco de dados: consultas em tabelas e visualizações, chamadas de função SQL (rpc), SQL bruto. |
get storage(): StorageService | Serviço de armazenamento: buckets, envio, download, URLs assinadas e públicas, transformações de imagens. |
get realtime(): RealtimeService | Atendimento em tempo real: canais, alterações de Postgres, transmissão (broadcast) e presença. |
get functions(): FunctionsService | Serviço Edge Functions: invocação e gerenciamento de jobs e cron com chave service_role. |
get ai(): AiService | Serviço de IA: conversação (chat), embeddings, RAG (ingest, queries, namespaces), busca semântica e sessões. |
get notifications(): NotificationsService | Serviço de notificações: envio (e-mail, SMS, push, webhook), histórico, templates e administração. |
| Método | Descrição |
|---|---|
dispose(): void | Desmonta o cliente: interrompe a atualização proativa (ticker + visibilidade + BroadcastChannel), desconecta em tempo real, esvazia ouvintes de autenticação. |
from<TableName extends string & keyof Schema['Tables'], Table extends Schema['Tables'][TableName]>(table: TableName): AuraQueryBuilder<Schema, Table, TableName, AuraClientOptionsT>from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(view: ViewName): AuraQueryBuilder<Schema, View, ViewName, AuraClientOptionsT>from(table: string): AuraQueryBuilder<any, any, any, AuraClientOptionsT> | Atalho: consulte uma tabela ou visualização do banco de dados (API compatível com Supabase). |
rpc<FnName extends string = string, Args extends Record<string, unknown> = Record<string, unknown>>(fn: FnName, args?: Args, options?: Parameters<DatabaseService<Database, Schema>['rpc']>[2]): ReturnType<DatabaseService<Database, Schema>['rpc']> | Atalho: chame um procedimento armazenado / função PostgreSQL via RPC (API compatível com Supabase). |
channel(name: string, options?: ChannelConfig): AuraChannel | Atalho: crie um canal em tempo real com API compatível com Supabase. |
removeChannel(channel: string | AuraChannel): void | Atalho: remova um canal em tempo real por nome ou instância do AuraChannel. |
removeAllChannels(): void | Atalho: remova todos os canais em tempo real e cancele a inscrição. |
getChannels(): AuraChannel[] | Atalho: lista todos os canais ativos em tempo real. |
Página gerada
Esta página é gerada a partir das declarações de tipo e comentários do SDK, portanto, não pode desviar do código publicado. Para exemplos resolvidos, leia os guias.
Última atualização · 12 de out. de 2026