Cliente y servicios
El punto de entrada del SDK: cómo crear el cliente y qué servicios expone.
6 min leer·Nivel referencia·Revisado el 12 oct 2026
Este texto en inglés se generó automáticamente a partir del original en francés y aún no ha sido revisado.
Esta página fue traducida automáticamente. La versión en inglés es autorizada.
#
Funciones
Funciones exportadas
| Función | Descripción |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Cree una nueva instancia de cliente Aurabase. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Crea un cliente para SERVER, use solo para operaciones de administración (client.authAdmin: enumerar/crear/prohibir usuarios, leer auditoría). |
#
clase
AuraCliente
Cliente principal Aurabase.
| Propiedad | Descripción |
|---|---|
readonly baseUrl: string | URL del proyecto (https://<slug>.aurabase.cloud), sin barra final. |
readonly apiKey: string | null | Clave API del proyecto (anon o service_role) enviada en el encabezado apikey; null si no se proporcionó ninguno. |
readonly fetchFn: typeof globalThis.fetch | Función fetch utilizada para todas las consultas (la de options.fetch, de lo contrario globalThis.fetch). |
readonly authStore: BaseAuthStore | Almacén de sesiones (token de acceso, token de actualización, usuario): memoria, localStorage o cookies según el contexto. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Lea la política de reanudación de solicitudes (GET, HEAD) en caso de error transitorio: habilitada o no, y número máximo de reanudaciones. |
readonly requestTimeoutMs?: number | Tiempo de espera predeterminado (ms) para solicitudes JSON sin señal. undefined → fallo central (30s). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Gancho de observabilidad: consulte AuraClientOptions.onEvent. |
readonly debug?: boolean | Escriba cada AuraObservabilityEvent a través de console.debug — ver AuraClientOptions.debug. |
get auth(): AuthService | Servicio de autenticación: registro, conexión, sesión, MFA, OAuth, identidades. |
get authAdmin(): AuthAdminService | API de administración de autenticación (usuarios, sesiones, registro de auditoría, plantillas de correo electrónico). |
get db(): DatabaseService<Database, Schema> | Servicio de base de datos: consultas sobre tablas y vistas, llamadas a funciones SQL (rpc), SQL sin formato. |
get storage(): StorageService | Servicio de almacenamiento: buckets, envío, descarga, URL firmadas y públicas, transformaciones de imágenes. |
get realtime(): RealtimeService | Servicio en tiempo real: canales, cambios de Postgres, transmisión (broadcast) y presencia. |
get functions(): FunctionsService | Servicio Edge Functions: invocación y gestión de trabajos y cron con una clave service_role. |
get ai(): AiService | Servicio de IA: conversación (chat), incrustaciones, RAG (ingesta, consultas, espacios de nombres), búsqueda semántica y sesiones. |
get notifications(): NotificationsService | Servicio de notificaciones: envío (email, SMS, push, webhook), historial, plantillas y administración. |
| Método | Descripción |
|---|---|
dispose(): void | Desmonta el cliente: detiene la actualización proactiva (ticker + visibilidad + BroadcastChannel), desconecta en tiempo real, vacía los oyentes de autenticación. |
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> | Acceso directo: consultar una tabla o vista de una base de datos (API compatible con 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']> | Atajo: llamar a un procedimiento almacenado/función PostgreSQL a través de RPC (API compatible con Supabase). |
channel(name: string, options?: ChannelConfig): AuraChannel | Atajo: cree un canal en tiempo real con API compatible con Supabase. |
removeChannel(channel: string | AuraChannel): void | Atajo: eliminar un canal en tiempo real por nombre o instancia de AuraChannel. |
removeAllChannels(): void | Atajo: eliminar todos los canales en tiempo real y cancelar la suscripción. |
getChannels(): AuraChannel[] | Acceso directo: enumera todos los canales activos en tiempo real. |
página generada
Esta página se genera a partir de las declaraciones de tipo y los comentarios del SDK, por lo que no puede derivarse del código publicado. Para ver ejemplos resueltos, lea las guías.
Última actualización · 12 oct 2026